Get one supplier
get
/fscmRestApi/resources/11.13.18.05/suppliersLOV/{SupplierId}
Request
Path Parameters
-
SupplierId(required): integer(int64)
Value that uniquely identifies the supplier.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : suppliersLOV-item-response
Type:
Show Source
object
-
AlternateName: string
Title:
Alternate Name
Read Only:true
Maximum Length:360
Alternate name of the supplier. -
BusinessRelationshipCode: string
Title:
Business Relationship
Read Only:true
Maximum Length:30
Abbreviation that identifies the business relationship between the enterprise and the supplier. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
DUNSNumber: string
Title:
D-U-N-S Number
Read Only:true
Maximum Length:30
Data Universal Numbering System (DUNS) that identifies the supplier business. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RegistryId: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Value that uniquely identifies the party in the supplier relationship. -
sitesLOV: array
Supplier Sites List of Values
Title:
Supplier Sites List of Values
The Supplier Sites List of Values resource searches for supplier sites. -
Status: string
Read Only:
true
Status of the supplier. Values include ACTIVE or INACTIVE. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierName: string
Title:
Supplier
Read Only:true
Maximum Length:360
Name of the supplier. -
SupplierNumber: string
Title:
Supplier Number
Read Only:true
Maximum Length:30
Number that identifies the supplier. -
SupplierPartyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier party. -
TaxRegistrationNumber: string
Title:
Registration Number
Read Only:true
Maximum Length:50
Number that identifies the value added tax that some countries use, such as, countries in the European Union.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Supplier Sites List of Values
Type:
array
Title:
Supplier Sites List of Values
The Supplier Sites List of Values resource searches for supplier sites.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : suppliersLOV-sitesLOV-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcurementBU: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the procurement business unit where the supplier site resides. -
ProcurementBUId: integer
(int64)
Title:
Procurement BU
Read Only:true
Value that uniquely identifies the procurement business unit where the supplier site resides. -
SitePurposePayFlag: boolean
Title:
Pay
Read Only:true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then a pay purpose exists for the supplier site. If false, then a pay purpose doesn't exist. The default value is false. -
SitePurposePrimaryPayFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then a primary pay purpose exists for the supplier site. If false, then a primary pay purpose doesn't exist. The default value is false. -
SitePurposeProcurementCardFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then a procurement card exists for the supplier site. If false, then a procurement card doesn't exist. The default value is false. -
SitePurposePurchasingFlag: boolean
Title:
Purchasing
Read Only:true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then a purchasing purpose exists for the supplier site. If false, then a purpose doesn't exist. The default value is false. -
SitePurposeSourcingOnlyFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the supplier site has a sourcing only purpose. If false, then the supplier site doesn't have a sourcing only purpose. The default value is false. -
Status: string
Read Only:
true
Status of the supplier site. -
SupplierAddressId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier address. -
SupplierAddressName: string
Title:
Site Name
Read Only:true
Maximum Length:240
Name of the supplier address. -
SupplierSite: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- sitesLOV
-
Parameters:
- SupplierId:
$request.path.SupplierId
The Supplier Sites List of Values resource searches for supplier sites. - SupplierId:
Examples
This example describes how to get one supplier.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliersLOV/SupplierId"
For example, the following command gets one supplier:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliersLOV/11"
Example Response Body
The following shows an example of the response body in JSON format.
{ "SupplierId" : 11, "SupplierPartyId" : 12444, "SupplierName" : "Advantage Corp", "SupplierNumber" : "1010", "AlternateName" : null, "Status" : "ACTIVE", "BusinessRelationshipCode" : "SPEND_AUTHORIZED", "DUNSNumber" : null, "TaxRegistrationNumber" : null, "RegistryId" : "9926", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/11", "name" : "suppliersLOV", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/11", "name" : "suppliersLOV", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/11/child/sitesLOV", "name" : "sitesLOV", "kind" : "collection" } ] }