Get one profile
get
/fscmRestApi/resources/11.13.18.05/supplierTradeProfiles/{SupplierTradeProfileId}
Request
Path Parameters
-
SupplierTradeProfileId(required): integer(int64)
Value that uniquely identifies the supplier trade profile. It is a primary key that the application generates when it creates the supplier trade profile.
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 : supplierTradeProfiles-item-response
Type:
Show Source
object
-
CategorySetId: integer
(int64)
Value that uniquely identifies the catalog assigned to a supplier.
-
ClientBusinessUnit: string
Maximum Length:
240
Name of the business unit. -
ClientBusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DefaultClaimOwner: string
Default owner for the claim.
-
DefaultClaimOwnerId: integer
(int64)
Value that uniquely identifies the default owner for the claim.
-
DefaultProgramOwner: string
Default owner for the program, if the program is created via the Supplier Portal.
-
DefaultProgramOwnerId: integer
(int64)
Value that uniquely identifies the default owner for the program.
-
EnabledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the supplier trade profile is enabled. If false, then the supplier trade profile is disabled. The default value is true. -
GracePeriodInDays: integer
(int64)
Number of days that the ship and debit can extend beyond the to date on a ship and debit program. The maximum value is 9999 days.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Login that the user used when updating the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessAccrualsForReturnsFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then accruals will be generated and processed for return orders. If false, then accruals will not be generated for return orders. The default value is false. -
Supplier: string
Maximum Length:
360
Name of the supplier supporting the channel program. -
SupplierAddress: string
Read Only:
true
Address of the supplier site. -
SupplierCatalog: string
Name of the catalog assigned to a supplier.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierNumber: string
Maximum Length:
30
Number that identifies the supplier. -
SupplierSite: string
Maximum Length:
240
Value that identifies the supplier site. Valid values should be sites where the supplier trade profile business unit is configured as Client to BU in supplier site assignments. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
SupplierTradeProfileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier trade profile. It is a primary key that the application generates when it creates the supplier trade profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
This example describes how to get one profile.
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/supplierTradeProfiles/SupplierTradeProfileId"
For example, the following command gets one profile:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierTradeProfiles/300100185773744"
Example Response Body
The following shows an example of the response body in JSON format.
{ "SupplierTradeProfileId": 300100185773744, "ClientBusinessUnit": "Vision Operations", "ClientBusinessUnitId": 204, "SupplierId": 1178, "Supplier": "CDS, Inc", "SupplierNumber": "5102", "SupplierSite": "PITTSBURGH", "SupplierSiteId": 2854, "EnabledFlag": true, "DefaultClaimOwner": "channel_user", "DefaultClaimOwnerId": 300100181693728, "GracePeriodInDays": null, "ProcessAccrualsForReturnsFlag": false, "CreatedBy": "channel_user", "CreationDate": "2020-06-03T02:32:20+00:00", "LastUpdateDate": "2020-06-03T02:32:20.108+00:00", "LastUpdatedBy": "channel_user", "links": [ { "rel": "self", "href": "server:port/fscmRestApi/resources/latest/supplierTradeProfiles/300100185773744", "name": "supplierTradeProfiles", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "server:port/fscmRestApi/resources/latest/supplierTradeProfiles/300100185773744", "name": "supplierTradeProfiles", "kind": "item" } ] }