Get one supplier contact for a supplier registration
get
/fscmRestApi/resources/11.13.18.05/supplierRegistrationRequests/{SupplierRegistrationKey}/child/contacts/{SupplierRegistrationContactId}
Request
Path Parameters
-
SupplierRegistrationContactId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
SupplierRegistrationKey(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : supplierRegistrationRequests-contacts-item-response
Type:
Show Source
object
-
AdministrativeContactFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier isn't an administrative contact.The default value is false. -
CreateUserAccountFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, create a user account for the supplier contact. If false, then don't create a user account for the supplier contact. The default value is false. -
DFF: array
DFF
-
Email: string
Title:
Email
Maximum Length:320
Email of the supplier contact in the registration. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:10
Abbreviation that identifies the area for the fax number of the supplier contact in the supplier registration. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
Abbreviation that identifies the country for the fax number of the supplier contact in the supplier registration. -
FaxNumber: string
Title:
Fax
Maximum Length:40
Fax number of the supplier contact in the supplier registration. -
FirstName: string
Title:
First Name
Maximum Length:150
First name of the supplier contact in the supplier registration. -
JobTitle: string
Title:
Job Title
Maximum Length:100
Job title of the supplier contact in the supplier registration. -
LastName: string
Title:
Last Name
Maximum Length:150
Last name of the supplier contact in the supplier registration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the supplier contact in the supplier registration. -
MobileAreaCode: string
Title:
Mobile Area Code
Maximum Length:10
Abbreviation that identifies the area for the mobile phone number of the supplier contact in the supplier registration. -
MobileCountryCode: string
Title:
Mobile Country Code
Maximum Length:10
Abbreviation that identifies the country for the mobile phone number of the supplier contact in the supplier registration. -
MobileNumber: string
Title:
Mobile
Maximum Length:40
Mobile phone number of the supplier contact in the supplier registration. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Abbreviation that identifies the area for the landline phone number of the supplier contact in the supplier registration. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Abbreviation that identifies the country for the landline phone number of the supplier contact in the supplier registration. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
Landline phone extension for the supplier contact in the supplier registration. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
Landline phone number for the supplier contact in the supplier registration. -
roles: array
Roles
Title:
Roles
The Roles resource manages user account roles of the supplier contact for supplier registration. -
Salutation: string
Maximum Length:
80
Honorific title of the supplier contact in the supplier registration. -
SalutationCode: string
Title:
Salutation
Maximum Length:30
Abbreviation that identifies the honorific title of the supplier contact in the supplier registration. A list of accepted values is defined in the lookup type CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
SupplierRegistrationContactId: integer
(int64)
Value that uniquely identifies a supplier contact in the supplier registration.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Roles
Type:
array
Title:
Roles
The Roles resource manages user account roles of the supplier contact for supplier registration.
Show Source
Nested Schema : supplierRegistrationRequests-contacts-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Enter Person Information
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Enter Person Information
-
ContactRequestId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : supplierRegistrationRequests-contacts-roles-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the supplier user role. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RoleId: integer
The unique identifier of the supplier user role.
-
RoleName: string
Maximum Length:
255
The name of the supplier user role. -
SupplierRegistrationContactRoleId: integer
(int64)
Value that uniquely identifies a role that's associated with a supplier contact for a supplier registration.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- SupplierRegistrationContactId:
$request.path.SupplierRegistrationContactId
- SupplierRegistrationKey:
$request.path.SupplierRegistrationKey
- SupplierRegistrationContactId:
- roles
-
Parameters:
- SupplierRegistrationContactId:
$request.path.SupplierRegistrationContactId
- SupplierRegistrationKey:
$request.path.SupplierRegistrationKey
The Roles resource manages user account roles of the supplier contact for supplier registration. - SupplierRegistrationContactId: