Jump to

• Request
• Response
• Examples

Get all contacts

get

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts

Request

Path Parameters

• SupplierId(required): integer(int64)
  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
• 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 based on 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 based on the primary key.
    Finder Variables
    • SupplierContactId; integer; Value that uniquely identifies the supplier contact.
• 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 isn't an administrative contact.The default value is false.
  • ContactName; string; Display name of the supplier contact.
  • Email; string; Email of the supplier contact.
  • FaxAreaCode; string; Abbreviation that identifies the area for the fax number of the supplier contact.
  • FaxCountryCode; string; Abbreviation that identifies the country for the fax number of the supplier contact.
  • FaxNumber; string; Fax number 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 number of the supplier contact.
  • MobileCountryCode; string; Abbreviation that identifies the country for the mobile phone number of the supplier contact.
  • MobileNumber; string; Mobile phone number of the supplier contact.
  • PersonProfileId; integer; The unique identifier of the person profile.
  • PhoneAreaCode; string; Abbreviation that identifies the area for the landline phone number of the supplier contact.
  • PhoneCountryCode; string; Abbreviation that identifies the country for the landline phone number of the supplier contact.
  • PhoneExtension; string; Landline phone extension for the supplier contact.
  • PhoneNumber; string; Landline phone number 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.
  • UserAccountStatus; string; Status of the supplier user account. Values are ACTIVE, INACTIVE, or PROCESSING.
• 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 : suppliers-contacts

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/suppliers-contacts-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."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object suppliers-contacts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-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 : suppliers-contacts-item-response

Type: object

Show Source

• addresses: array Contact Addresses
  Title: Contact Addresses

  Supplier contact addresses are retrieved.
• 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 isn't an administrative contact.The default value is false.
• ContactName: string
  Read Only: true

  Maximum Length: 255

  Display name of the supplier contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the supplier contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the application created the supplier contact.
• dataaccess: array Data Access
  Title: Data Access

  Data access of supplier contacts.
• DataAccessLevel: string
  Title: Data Access Level

  Read Only: true

  Maximum Length: 30

  Data access level for the supplier contact. Access can be at the supplier level or at the selected sites level.
• DFF: array DFF
• 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 number of the supplier contact.
• FaxCountryCode: string
  Title: Fax Country Code

  Maximum Length: 10

  Abbreviation that identifies the country for the fax number of the supplier contact.
• FaxNumber: string
  Title: Fax

  Maximum Length: 40

  Fax number 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 when the supplier contact row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the supplier contact row.
• 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 number of the supplier contact.
• MobileCountryCode: string
  Title: Mobile Country Code

  Maximum Length: 10

  Abbreviation that identifies the country for the mobile phone number of the supplier contact.
• MobileNumber: string
  Title: Mobile

  Maximum Length: 40

  Mobile phone number of the supplier contact.
• PersonProfileId: integer (int64)
  The unique identifier of the person profile.
• PhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 20

  Abbreviation that identifies the area for the landline phone number of the supplier contact.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  Abbreviation that identifies the country for the landline phone number of the supplier contact.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20

  Landline phone extension for the supplier contact.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  Landline phone number for the supplier contact.
• roles: array Roles
  Title: Roles

  Supplier contact user roles are retrieved.
• 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. Values are ACTIVE or INACTIVE.
• SupplierContactId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier contact.
• UserAccountStatus: string
  Title: User Account Status

  Read Only: true

  Maximum Length: 255

  Status of the supplier user account. Values are ACTIVE, INACTIVE, or PROCESSING.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name of the user account for a supplier contact.

{
    "type":"object",
    "properties":{
        "AdministrativeContactFlag":{
            "title":"Administrative Contact",
            "maxLength":255,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AdminContactRoleStatus"
                ]
            },
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the supplier contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the application created the supplier contact.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DataAccessLevel":{
            "title":"Data Access Level",
            "maxLength":30,
            "type":"string",
            "description":"Data access level for the supplier contact. Access can be at the supplier level or at the selected sites level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Email":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxAreaCode":{
            "title":"Fax Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the fax number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxCountryCode":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the fax number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":40,
            "type":"string",
            "description":"Fax number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "InactiveDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the supplier contact is no longer active.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            }
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"Job title of the supplier contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the supplier contact row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the supplier contact row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "MobileAreaCode":{
            "title":"Mobile Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the mobile phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "MobileCountryCode":{
            "title":"Mobile Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the mobile phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "MobileNumber":{
            "title":"Mobile",
            "maxLength":40,
            "type":"string",
            "description":"Mobile phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PersonProfileId":{
            "type":"integer",
            "description":"The unique identifier of the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the landline phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the landline phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"Landline phone extension for the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"Landline phone number for the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":80,
            "type":"string",
            "description":"Honorific title of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalutationCode":{
            "title":"Salutation",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the supplier contact. Values are ACTIVE or INACTIVE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InactiveDate"
                ]
            }
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UserAccountStatus":{
            "title":"User Account Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the supplier user account. Values are ACTIVE, INACTIVE, or PROCESSING.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name of the user account for a supplier contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "addresses":{
            "title":"Contact Addresses",
            "type":"array",
            "description":"Supplier contact addresses are retrieved.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-addresses-item-response"
            }
        },
        "dataaccess":{
            "title":"Data Access",
            "type":"array",
            "description":"Data access of supplier contacts.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-dataaccess-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "roles":{
            "title":"Roles",
            "type":"array",
            "description":"Supplier contact user roles are retrieved.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-roles-item-response"
            }
        }
    }
}

Nested Schema : Contact Addresses

Type: array

Title: Contact Addresses

Supplier contact addresses are retrieved.

Show Source

• Array of: object suppliers-contacts-addresses-item-response

{
    "title":"Contact Addresses",
    "type":"array",
    "description":"Supplier contact addresses are retrieved.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-addresses-item-response"
    }
}

Nested Schema : Data Access

Type: array

Title: Data Access

Data access of supplier contacts.

Show Source

• Array of: object suppliers-contacts-dataaccess-item-response

{
    "title":"Data Access",
    "type":"array",
    "description":"Data access of supplier contacts.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-dataaccess-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object suppliers-contacts-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Roles

Type: array

Title: Roles

Supplier contact user roles are retrieved.

Show Source

• Array of: object suppliers-contacts-roles-item-response

{
    "title":"Roles",
    "type":"array",
    "description":"Supplier contact user roles are retrieved.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-roles-item-response"
    }
}

Nested Schema : suppliers-contacts-addresses-item-response

Type: object

Show Source

• AddressName: string
  Title: Address Name

  Maximum Length: 255

  Name of the supplier address associated with a supplier contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who associated the supplier address with a supplier contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the application associated the supplier address with a supplier contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the supplier address and supplier contact association row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the supplier address and supplier contact association row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SupplierAddressId: integer (int64)
  Value that uniquely identifies the supplier address associated to a supplier contact.
• SupplierContactAddressId: integer
  Value that uniquely identifies the supplier address and supplier contact association.

{
    "type":"object",
    "properties":{
        "AddressName":{
            "title":"Address Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier address associated with a supplier contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AddressName1"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who associated the supplier address with a supplier contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the application associated the supplier address with a supplier contact.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the supplier address and supplier contact association row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the supplier address and supplier contact association row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address associated to a supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierContactAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address and supplier contact association.",
            "nullable":false,
            "x-queryable":true
        },
        "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."
        }
    }
}

Nested Schema : suppliers-contacts-dataaccess-item-response

Type: object

Show Source

• AccessCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the data access of the supplier user.
• AccessValue: integer (int64)
  Read Only: true

  Data access value of the supplier.
• Address: string
  Title: Address Name

  Read Only: true

  Maximum Length: 4000

  Name of the supplier site address.
• BUId: number
  Title: Procurement BU

  Read Only: true

  Unique identifier for the procurement BU of the site to which the supplier user has data access.
• BUName: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Procurement BU of the site to which the supplier user has data access.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentSupplier: string
  Title: Parent Supplier

  Read Only: true

  Maximum Length: 360

  Parent supplier of the supplier to which the supplier user has data access.
• ParentSupplierId: number
  Title: Parent Supplier

  Read Only: true

  Unique identifier for the parent supplier of the supplier to which the supplier user has data access.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the supplier for which the supplier has data access to.
• SupplierContactId: integer (int64)
  Read Only: true

  Unique identifier for the supplier contact for whom data access is being provisioned or updated.
• SupplierId: integer (int64)
  Title: Supplier

  Read Only: true

  Unique identifier for the supplier to which the supplier user has data access.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Supplier site to which the supplier user has data access.
• SupplierSiteId: number
  Title: Supplier Site

  Read Only: true

  Unique identifier for the supplier site to which the supplier user has data access.

{
    "type":"object",
    "properties":{
        "AccessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data access of the supplier user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessValue":{
            "type":"integer",
            "description":"Data access value of the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address":{
            "title":"Address Name",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supplier site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BUId":{
            "title":"Procurement BU",
            "type":"number",
            "description":"Unique identifier for the procurement BU of the site to which the supplier user has data access.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BUName":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement BU of the site to which the supplier user has data access.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentSupplier":{
            "title":"Parent Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Parent supplier of the supplier to which the supplier user has data access.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentSupplierId":{
            "title":"Parent Supplier",
            "type":"number",
            "description":"Unique identifier for the parent supplier of the supplier to which the supplier user has data access.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier for which the supplier has data access to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Unique identifier for the supplier contact for whom data access is being provisioned or updated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier",
            "type":"integer",
            "description":"Unique identifier for the supplier to which the supplier user has data access.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Supplier site to which the supplier user has data access.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "title":"Supplier Site",
            "type":"number",
            "description":"Unique identifier for the supplier site to which the supplier user has data access.",
            "nullable":true,
            "readOnly":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 : suppliers-contacts-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Enter Person Information

  Maximum Length: 30

  Enter Person Information
• __FLEX_Context_DisplayValue: string
  Title: Enter Person Information

  Enter Person Information
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonProfileId: integer (int64)

{
    "type":"object",
    "properties":{
        "PersonProfileId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Enter Person Information",
            "maxLength":30,
            "type":"string",
            "description":"Enter Person Information",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Enter Person Information",
            "type":"string",
            "description":"Enter Person Information",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "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 : suppliers-contacts-roles-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  Description of the role that the supplier contact has access to.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleId: integer (int64)
  Title: Role

  Value that uniquely identifies the role for which the supplier contact has access.
• RoleName: string
  Title: Role

  Maximum Length: 240

  Name of the role that the supplier contact has access to.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the role that the supplier contact has access to.",
            "nullable":true,
            "x-queryable":false
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"Value that uniquely identifies the role for which the supplier contact has access.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role",
            "maxLength":240,
            "type":"string",
            "description":"Name of the role that the supplier contact has access to.",
            "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"
    }
}

Back to Top

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" : "[e-mail]",
    "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" : "[e-mail]",
    "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"
  } ]
}

Back to Top