Create one contact

post

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

Request

Path Parameters
  • 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=
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Contact Addresses
    Title: Contact Addresses
    Supplier contact addresses are retrieved.
  • 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.
  • Data Access
    Title: Data Access
    Data access of supplier contacts.
  • DFF
  • Title: Email
    Maximum Length: 320
    Email of the supplier contact.
  • Title: Fax Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the fax number of the supplier contact.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax number of the supplier contact.
  • Title: Fax
    Maximum Length: 40
    Fax number of the supplier contact.
  • Title: First Name
    Maximum Length: 150
    First name of the supplier contact.
  • Title: Inactive Date
    Date when the supplier contact is no longer active.
  • Title: Job Title
    Maximum Length: 100
    Job title of the supplier contact.
  • Title: Last Name
    Maximum Length: 150
    Last name of the supplier contact.
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the supplier contact.
  • Title: Mobile Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the mobile phone number of the supplier contact.
  • Title: Mobile Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the mobile phone number of the supplier contact.
  • Title: Mobile
    Maximum Length: 40
    Mobile phone number of the supplier contact.
  • The unique identifier of the person profile.
  • Title: Phone Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the landline phone number of the supplier contact.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the landline phone number of the supplier contact.
  • Title: Phone Extension
    Maximum Length: 20
    Landline phone extension for the supplier contact.
  • Title: Phone
    Maximum Length: 40
    Landline phone number for the supplier contact.
  • Roles
    Title: Roles
    Supplier contact user roles are retrieved.
  • Title: Salutation
    Maximum Length: 80
    Honorific title of the supplier contact.
  • 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.
Nested Schema : Contact Addresses
Type: array
Title: Contact Addresses
Supplier contact addresses are retrieved.
Show Source
Nested Schema : Data Access
Type: array
Title: Data Access
Data access of supplier contacts.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Roles
Type: array
Title: Roles
Supplier contact user roles are retrieved.
Show Source
Nested Schema : suppliers-contacts-addresses-item-post-request
Type: object
Show Source
Nested Schema : suppliers-contacts-dataaccess-item-post-request
Type: object
Show Source
Nested Schema : suppliers-contacts-DFF-item-post-request
Type: object
Show Source
Nested Schema : suppliers-contacts-roles-item-post-request
Type: object
Show Source
  • Title: Description
    Maximum Length: 240
    Description of the role that the supplier contact has access to.
  • Title: Role
    Value that uniquely identifies the role for which the supplier contact has access.
  • Title: Role
    Maximum Length: 240
    Name of the role that the supplier contact has access to.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
  • Contact Addresses
    Title: Contact Addresses
    Supplier contact addresses are retrieved.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Display name of the supplier contact.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the supplier contact.
  • Title: Creation Date
    Read Only: true
    Date and time when the application created the supplier contact.
  • Data Access
    Title: Data Access
    Data access of supplier contacts.
  • 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
  • Title: Email
    Maximum Length: 320
    Email of the supplier contact.
  • Title: Fax Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the fax number of the supplier contact.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax number of the supplier contact.
  • Title: Fax
    Maximum Length: 40
    Fax number of the supplier contact.
  • Title: First Name
    Maximum Length: 150
    First name of the supplier contact.
  • Title: Inactive Date
    Date when the supplier contact is no longer active.
  • Title: Job Title
    Maximum Length: 100
    Job title of the supplier contact.
  • Title: Last Name
    Maximum Length: 150
    Last name of the supplier contact.
  • Title: Last Updated Date
    Read Only: true
    Date when the supplier contact row was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the supplier contact row.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the supplier contact.
  • Title: Mobile Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the mobile phone number of the supplier contact.
  • Title: Mobile Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the mobile phone number of the supplier contact.
  • Title: Mobile
    Maximum Length: 40
    Mobile phone number of the supplier contact.
  • The unique identifier of the person profile.
  • Title: Phone Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the landline phone number of the supplier contact.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the landline phone number of the supplier contact.
  • Title: Phone Extension
    Maximum Length: 20
    Landline phone extension for the supplier contact.
  • Title: Phone
    Maximum Length: 40
    Landline phone number for the supplier contact.
  • Roles
    Title: Roles
    Supplier contact user roles are retrieved.
  • Title: Salutation
    Maximum Length: 80
    Honorific title of the supplier contact.
  • 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.
  • Title: Status
    Read Only: true
    Maximum Length: 255
    Status of the supplier contact. Values are ACTIVE or INACTIVE.
  • Read Only: true
    Value that uniquely identifies the supplier contact.
  • Title: User Account Status
    Read Only: true
    Maximum Length: 255
    Status of the supplier user account. Values are ACTIVE, INACTIVE, or PROCESSING.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    User name of the user account for a supplier contact.
Nested Schema : Contact Addresses
Type: array
Title: Contact Addresses
Supplier contact addresses are retrieved.
Show Source
Nested Schema : Data Access
Type: array
Title: Data Access
Data access of supplier contacts.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Roles
Type: array
Title: Roles
Supplier contact user roles are retrieved.
Show Source
Nested Schema : suppliers-contacts-addresses-item-response
Type: object
Show Source
Nested Schema : suppliers-contacts-dataaccess-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the data access of the supplier user.
  • Read Only: true
    Data access value of the supplier.
  • Title: Address Name
    Read Only: true
    Maximum Length: 4000
    Name of the supplier site address.
  • Title: Procurement BU
    Read Only: true
    Unique identifier for the procurement BU of the site to which the supplier user has data access.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Procurement BU of the site to which the supplier user has data access.
  • Links
  • Title: Parent Supplier
    Read Only: true
    Maximum Length: 360
    Parent supplier of the supplier to which the supplier user has data access.
  • Title: Parent Supplier
    Read Only: true
    Unique identifier for the parent supplier of the supplier to which the supplier user has data access.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier for which the supplier has data access to.
  • Read Only: true
    Unique identifier for the supplier contact for whom data access is being provisioned or updated.
  • Title: Supplier
    Read Only: true
    Unique identifier for the supplier to which the supplier user has data access.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 240
    Supplier site to which the supplier user has data access.
  • Title: Supplier Site
    Read Only: true
    Unique identifier for the supplier site to which the supplier user has data access.
Nested Schema : suppliers-contacts-DFF-item-response
Type: object
Show Source
Nested Schema : suppliers-contacts-roles-item-response
Type: object
Show Source
  • Title: Description
    Maximum Length: 240
    Description of the role that the supplier contact has access to.
  • Links
  • Title: Role
    Value that uniquely identifies the role for which the supplier contact has access.
  • Title: Role
    Maximum Length: 240
    Name of the role that the supplier contact has access to.
Back to Top

Examples

This example describes how to create a supplier contact.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/contacts"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{ 
	"Salutation": "Ms.",
	"FirstName": "Jill",
	"LastName": "Smith",
	"AdministrativeContactFlag": true,
	"MobileCountryCode": "1",
	"MobileAreaCode": "650",
	"MobileNumber": "555-2234"    
	
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"SupplierContactId": 300100176689669,
	"SalutationCode": "MS.",
	"Salutation": "Ms.",
	"FirstName": "Jill",
	"MiddleName": null,
	"LastName": "Smith",
	"JobTitle": null,
	"AdministrativeContactFlag": true,
	"PhoneCountryCode": null,
	"PhoneAreaCode": null,
	"PhoneNumber": null,
	"PhoneExtension": null,
	"MobileCountryCode": "1",
	"MobileAreaCode": "650",
	"MobileNumber": "555-2234",
	"FaxCountryCode": null,
	"FaxAreaCode": null,
	"FaxNumber": null,
	"Email": null,
	"Status": "ACTIVE",
	"InactiveDate": null,
	"PersonProfileId": 300100176689669,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/contacts/300100176689669",
		"name": "contacts",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000A77040000000A737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000017371007E0002000000017371007E0002000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C7371007E00020000000171007E000B71007E000B78"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/contacts/300100176689669",
		"name": "contacts",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652",
		"name": "suppliers",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/contacts/300100176689669/lov/SalutationLookup",
		"name": "SalutationLookup",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/contacts/300100176689669/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/contacts/300100176689669/child/addresses",
		"name": "addresses",
		"kind": "collection"
	}
	]
}
Back to Top