Create one contact
post
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts
Request
Path Parameters
-
SupplierId(required): integer(int64)
Value that uniquely identifies the supplier.
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
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. -
DFF: array
Flexfields for Supplier Contacts
Title:
Flexfields for Supplier Contacts
The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields. -
Email(required): 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(required): 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. -
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.
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 : suppliers-contacts-addresses-item-post-request
Type:
Show Source
object
-
AddressName: string
Title:
Address Name
Maximum Length:255
Name of the supplier address that is associated to the supplier contact. -
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 : suppliers-contacts-DFF-item-post-request
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. -
PersonProfileId: integer
(int64)
Value that uniquely identifies the person profile.
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.
Root 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
Links
- DFF
-
Parameters:
- SupplierContactId:
$request.path.SupplierContactId
- SupplierId:
$request.path.SupplierId
The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields. - SupplierContactId:
- addresses
-
Parameters:
- SupplierContactId:
$request.path.SupplierContactId
- SupplierId:
$request.path.SupplierId
The Contact Addresses resource manages supplier contact addresses. - SupplierContactId:
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" } ] }