Get all contacts
get
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts
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 -
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 supplier contacts according to the primary key.
Finder Variables:- PersonProfileId; integer; Value that uniquely identifies the person profile.
- SupplierContactId; integer; Value that uniquely identifies the supplier contact.
- PrimaryKeyFinder: Finds supplier contacts according to the primary key.
Finder Variables:- SupplierContactId; string; Value that uniquely identifies the supplier contact.
- PrimaryKey: Finds supplier contacts according to the primary key.
-
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:- AdministrativeContactFlag; boolean; Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier is not an administrative contact. The default value is false.
- Email; string; Email of the supplier contact.
- FaxAreaCode; string; Abbreviation that identifies the area for the fax of the supplier contact.
- FaxCountryCode; string; Abbreviation that identifies the country for the fax of the supplier contact.
- FaxNumber; string; Fax of the supplier contact.
- FirstName; string; First name of the supplier contact.
- JobTitle; string; Job title of the supplier contact.
- LastName; string; Last name of the supplier contact.
- MiddleName; string; Middle name of the supplier contact.
- MobileAreaCode; string; Abbreviation that identifies the area for the mobile phone of the supplier contact.
- MobileCountryCode; string; Abbreviation that identifies the country for the mobile phone of the supplier contact.
- MobileNumber; string; Mobile phone number of the supplier contact.
- PersonProfileId; integer; Value that uniquely identifies the person profile.
- PhoneAreaCode; string; Abbreviation that identifies the area for the phone of the supplier contact.
- PhoneCountryCode; string; Abbreviation that identifies the country for the phone of the supplier contact.
- PhoneExtension; string; Phone extension for the supplier contact.
- PhoneNumber; string; Phone for the supplier contact.
- Salutation; string; Honorific title of the supplier contact.
- SalutationCode; string; Abbreviation that identifies the honorific title of the supplier contact. 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.
- SupplierContactId; integer; Value that uniquely identifies the supplier contact.
-
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:
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:
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.
Root Schema : suppliers-contacts
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : suppliers-contacts-item-response
Type:
Show Source
object
-
addresses: array
Contact Addresses
Title:
Contact Addresses
The Contact Addresses resource manages supplier contact addresses. -
AdministrativeContactFlag: boolean
Title:
Administrative contact
Maximum Length:255
Contains one of the following values: true or false. If true, then the supplier is an administrative contact. If false, then the supplier is not an administrative contact. The default value is false. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the supplier record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the supplier record. -
DFF: array
Flexfields for Supplier Contacts
Title:
Flexfields for Supplier Contacts
The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields. -
Email: string
Title:
Email
Maximum Length:320
Email of the supplier contact. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:20
Abbreviation that identifies the area for the fax of the supplier contact. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
Abbreviation that identifies the country for the fax of the supplier contact. -
FaxNumber: string
Title:
Fax
Maximum Length:40
Fax of the supplier contact. -
FirstName: string
Title:
First Name
Maximum Length:150
First name of the supplier contact. -
InactiveDate: string
(date)
Title:
Inactive Date
Date when the supplier contact is no longer active. -
JobTitle: string
Title:
Job Title
Maximum Length:100
Job title of the supplier contact. -
LastName: string
Title:
Last Name
Maximum Length:150
Last name of the supplier contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the supplier record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the supplier record. -
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. -
MobileAreaCode: string
Title:
Mobile Area Code
Maximum Length:20
Abbreviation that identifies the area for the mobile phone of the supplier contact. -
MobileCountryCode: string
Title:
Mobile Country Code
Maximum Length:10
Abbreviation that identifies the country for the mobile phone of the supplier contact. -
MobileNumber: string
Title:
Mobile
Maximum Length:40
Mobile phone number of the supplier contact. -
PersonProfileId: integer
(int64)
Value that uniquely identifies the person profile.
-
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:20
Abbreviation that identifies the area for the phone of the supplier contact. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Abbreviation that identifies the country for the phone of the supplier contact. -
PhoneExtension: string
Title:
Phone Extension
Maximum Length:20
Phone extension for the supplier contact. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
Phone for the supplier contact. -
Salutation: string
Title:
Salutation
Maximum Length:80
Honorific title of the supplier contact. -
SalutationCode: string
Title:
Salutation
Maximum Length:30
Abbreviation that identifies the honorific title of the supplier contact. 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. -
Status: string
Title:
Status
Read Only:true
Maximum Length:255
Status of the supplier contact. -
SupplierContactId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier contact.
Nested Schema : Contact Addresses
Type:
array
Title:
Contact Addresses
The Contact Addresses resource manages supplier contact addresses.
Show Source
Nested Schema : Flexfields for Supplier Contacts
Type:
array
Title:
Flexfields for Supplier Contacts
The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : suppliers-contacts-addresses-item-response
Type:
Show Source
object
-
AddressName: string
Title:
Address Name
Maximum Length:255
Name of the supplier address that is associated to the supplier contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the supplier record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the supplier record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the supplier record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the supplier record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierAddressId: integer
(int64)
Value that uniquely identifies the supplier address that is associated to the supplier contact.
-
SupplierContactAddressId: integer
Value that uniquely identifies the supplier contact address.
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 : suppliers-contacts-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Enter Person Information
Maximum Length:30
Descriptive flexfield context name for supplier sites. -
__FLEX_Context_DisplayValue: string
Title:
Enter Person Information
Descriptive flexfield context display value for supplier sites. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonProfileId: integer
(int64)
Value that uniquely identifies the person profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all contacts.
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/suppliers/SupplierId/child/contacts"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "SupplierContactId" : 100000011547058, "PersonProfileId" : 100000011547059, "SalutationCode" : null, "Salutation" : null, "FirstName" : "Henry", "MiddleName" : null, "LastName" : "Jones", "JobTitle" : null, "AdministrativeContactFlag" : true, "PhoneCountryCode" : null, "PhoneAreaCode" : null, "PhoneNumber" : null, "PhoneExtension" : null, "MobileCountryCode" : null, "MobileAreaCode" : null, "MobileNumber" : null, "FaxCountryCode" : null, "FaxAreaCode" : null, "FaxNumber" : null, "Email" : "sendmail-test-discard@example.com", "Status" : "ACTIVE", "InactiveDate" : null "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058", "name" : "contacts", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000067704000000067372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000371007E000371007E000371007E000371007E000378" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058", "name" : "contacts", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230", "name" : "suppliers", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058/lov/SalutationLookup", "name" : "SalutationLookup", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058/child/DFF", "name" : "DFF", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058/child/addresses", "name" : "addresses", "kind" : "collection" } ] }, { "SupplierContactId" : 100000011552266, "PersonProfileId" : 100000011552267, "SalutationCode" : null, "Salutation" : null, "FirstName" : "Emily", "MiddleName" : null, "LastName" : "Jones", "JobTitle" : null, "AdministrativeContactFlag" : true, "PhoneCountryCode" : null, "PhoneAreaCode" : null, "PhoneNumber" : null, "PhoneExtension" : null, "MobileCountryCode" : null, "MobileAreaCode" : null, "MobileNumber" : null, "FaxCountryCode" : null, "FaxAreaCode" : null, "FaxNumber" : null, "Email" : "sendmail-test-discard@example.com", "Status" : "ACTIVE", "InactiveDate" : null "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266", "name" : "contacts", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000067704000000067372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000371007E000371007E000371007E000371007E000378" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266", "name" : "contacts", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230", "name" : "suppliers", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266/lov/SalutationLookup", "name" : "SalutationLookup", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266/child/DFF", "name" : "DFF", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266/child/addresses", "name" : "addresses", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts", "name" : "contacts", "kind" : "collection" } ] }