Jump to

• Request
• Response

Get details of one external data providers

get

/fscmRestApi/resources/11.13.18.05/externalDataProviderForSuppliers

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds an external data provider for suppliers based on the primary key.
    Finder Variables
    • ExternalDataProviderId; integer; Unique identifier of the external data provider for suppliers.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DetailsAPISessionMaximumCount; integer; The maximum number of company selections a user can make in a session of the self-service supplier registration.
  • EnabledFlag; boolean; Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.
  • ExternalDataProviderCode; string; Abbreviation that identifies the external data provider for suppliers. For example, Dun & Bradstreet is called D&B.
  • ExternalDataProviderId; integer; External data provider for suppliers.
  • PrimaryFlag; boolean; Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.
  • SearchAPISessionMaximumCount; integer; The maximum number of searches a user can make in a session of the self-service supplier registration.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : externalDataProviderForSuppliers

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/externalDataProviderForSuppliers-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object externalDataProviderForSuppliers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/externalDataProviderForSuppliers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : externalDataProviderForSuppliers-item-response

Type: object

Show Source

• CompanyIconProviderAttr: string
  Title: Path for Company Logo

  Maximum Length: 4000

  Path in the external data provider response payload for the icon of the company returned as a match.
• CompanyNameProviderAttr: string
  Title: Path for Company Name

  Maximum Length: 4000

  Path in the external data provider response payload for the company name that's returned as a match.
• CompanyURLProviderAttr: string
  Title: Path for Company URL

  Maximum Length: 4000

  Path in the external data provider response payload for the website of the company returned as a match.
• DetailsAPISessionMaximumCount: integer (int64)
  Title: Company Selection Limit per Session

  The maximum number of company selections a user can make in a session of the self-service supplier registration.
• EnabledFlag: boolean
  Title: Provider Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.
• ExternalDataProviderCode: string
  Title: Provider Code

  Maximum Length: 255

  Abbreviation that identifies the external data provider for suppliers. For example, Dun & Bradstreet is called D&B.
• ExternalDataProviderId: integer (int64)
  Title: Provider ID

  External data provider for suppliers.
• ExternalDataProviderName: string
  Title: Provider Name

  Maximum Length: 4000

  Company name of the external data provider for suppliers.
• FirstAdditionalContext: string
  Title: Path for First Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the first user-defined attribute of the company returned as a match.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: boolean
  Title: Primary Provider

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.
• ProviderIdentifier: string
  Title: Path for Company Identifier

  Maximum Length: 4000

  Path in the external data provider response payload for the provider identifier that uniquely identifies the company returned as a match.
• SearchAPISessionMaximumCount: integer (int64)
  Title: Company Search Limit per Session

  The maximum number of searches a user can make in a session of the self-service supplier registration.
• SearchCandidates: string
  Title: Path for List of Companies

  Maximum Length: 4000

  Path in the external data provider response payload for the search candidates that are returned as matches.
• SearchURL: string
  Title: Provider Search URL

  Maximum Length: 4000

  Search URL of the REST API provided by the external data provider for suppliers.
• SecondAdditionalContext: string
  Title: Path for Second Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the second user-defined attribute of the company returned as a match.
• ThirdAdditionalContext: string
  Title: Path for Third Additional Company Attribute

  Maximum Length: 4000

  Path in the external data provider response payload for the third user-defined attribute of the company returned as a match.

{
    "type":"object",
    "properties":{
        "CompanyIconProviderAttr":{
            "title":"Path for Company Logo",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the icon of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "CompanyNameProviderAttr":{
            "title":"Path for Company Name",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the company name that's returned as a match.",
            "nullable":false,
            "x-queryable":false
        },
        "CompanyURLProviderAttr":{
            "title":"Path for Company URL",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the website of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "DetailsAPISessionMaximumCount":{
            "title":"Company Selection Limit per Session",
            "type":"integer",
            "description":"The maximum number of company selections a user can make in a session of the self-service supplier registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Provider Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external data provider for suppliers isn't configured. If false, then the data provider is configured. The default value is false.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ExternalDataProviderCode":{
            "title":"Provider Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the external data provider for suppliers. For example, Dun & Bradstreet is called D&B.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalDataProviderId":{
            "title":"Provider ID",
            "type":"integer",
            "description":"External data provider for suppliers.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExternalDataProviderName":{
            "title":"Provider Name",
            "maxLength":4000,
            "type":"string",
            "description":"Company name of the external data provider for suppliers.",
            "nullable":false,
            "x-queryable":false
        },
        "FirstAdditionalContext":{
            "title":"Path for First Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the first user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary Provider",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external data provider for suppliers is configured as primary. If false, then the data provider isn't configured as primary one. The default value is false.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ProviderIdentifier":{
            "title":"Path for Company Identifier",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the provider identifier that uniquely identifies the company returned as a match.",
            "nullable":false,
            "x-queryable":false
        },
        "SearchAPISessionMaximumCount":{
            "title":"Company Search Limit per Session",
            "type":"integer",
            "description":"The maximum number of searches a user can make in a session of the self-service supplier registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SearchCandidates":{
            "title":"Path for List of Companies",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the search candidates that are returned as matches.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchURL":{
            "title":"Provider Search URL",
            "maxLength":4000,
            "type":"string",
            "description":"Search URL of the REST API provided by the external data provider for suppliers.",
            "nullable":false,
            "x-queryable":false
        },
        "SecondAdditionalContext":{
            "title":"Path for Second Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the second user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "ThirdAdditionalContext":{
            "title":"Path for Third Additional Company Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Path in the external data provider response payload for the third user-defined attribute of the company returned as a match.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top