Create one contact
post
/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=
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.
-
Upsert-Mode: string
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 AddressesSupplier contact addresses are retrieved. -
AdministrativeContactFlag: boolean
Title:
Administrative ContactMaximum Length:255Contains 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. -
dataaccess: array
Data Access
Title:
Data AccessData access of supplier contacts. -
DFF: array
DFF
-
Email(required): string
Title:
EmailMaximum Length:320Email of the supplier contact. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:20Abbreviation that identifies the area for the fax number of the supplier contact. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:10Abbreviation that identifies the country for the fax number of the supplier contact. -
FaxNumber: string
Title:
FaxMaximum Length:40Fax number of the supplier contact. -
FirstName: string
Title:
First NameMaximum Length:150First name of the supplier contact. -
InactiveDate(required): string
(date)
Title:
Inactive DateDate when the supplier contact is no longer active. -
JobTitle: string
Title:
Job TitleMaximum Length:100Job title of the supplier contact. -
LastName: string
Title:
Last NameMaximum Length:150Last name of the supplier contact. -
MiddleName: string
Title:
Middle NameMaximum Length:60Middle name of the supplier contact. -
MobileAreaCode: string
Title:
Mobile Area CodeMaximum Length:20Abbreviation that identifies the area for the mobile phone number of the supplier contact. -
MobileCountryCode: string
Title:
Mobile Country CodeMaximum Length:10Abbreviation that identifies the country for the mobile phone number of the supplier contact. -
MobileNumber: string
Title:
MobileMaximum Length:40Mobile phone number of the supplier contact. -
PersonProfileId: integer
(int64)
The unique identifier of the person profile.
-
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:20Abbreviation that identifies the area for the landline phone number of the supplier contact. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Abbreviation that identifies the country for the landline phone number of the supplier contact. -
PhoneExtension: string
Title:
Phone ExtensionMaximum Length:20Landline phone extension for the supplier contact. -
PhoneNumber: string
Title:
PhoneMaximum Length:40Landline phone number for the supplier contact. -
roles: array
Roles
Title:
RolesSupplier contact user roles are retrieved. -
Salutation: string
Title:
SalutationMaximum Length:80Honorific title of the supplier contact. -
SalutationCode: string
Title:
SalutationMaximum Length:30Abbreviation 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:
arrayTitle:
Contact AddressesSupplier contact addresses are retrieved.
Show Source
Nested Schema : Data Access
Type:
arrayTitle:
Data AccessData access of supplier contacts.
Show Source
Nested Schema : Roles
Type:
arrayTitle:
RolesSupplier contact user roles are retrieved.
Show Source
Nested Schema : suppliers-contacts-addresses-item-post-request
Type:
Show Source
object-
AddressName: string
Title:
Address NameMaximum Length:255Name of the supplier address associated with a supplier contact. -
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.
Nested Schema : suppliers-contacts-DFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Enter Person InformationMaximum Length:30Enter Person Information -
__FLEX_Context_DisplayValue: string
Title:
Enter Person InformationEnter Person Information -
PersonProfileId: integer
(int64)
Nested Schema : suppliers-contacts-roles-item-post-request
Type:
Show Source
object-
Description: string
Title:
DescriptionMaximum Length:240Description of the role that the supplier contact has access to. -
RoleId: integer
(int64)
Title:
RoleValue that uniquely identifies the role for which the supplier contact has access. -
RoleName: string
Title:
RoleMaximum Length:240Name of the role that the supplier contact has access to.
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 AddressesSupplier contact addresses are retrieved. -
AdministrativeContactFlag: boolean
Title:
Administrative ContactMaximum Length:255Contains 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:
trueMaximum Length:255Display name of the supplier contact. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the supplier contact. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the application created the supplier contact. -
dataaccess: array
Data Access
Title:
Data AccessData access of supplier contacts. -
DataAccessLevel: string
Title:
Data Access LevelRead Only:trueMaximum Length:30Data 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:
EmailMaximum Length:320Email of the supplier contact. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:20Abbreviation that identifies the area for the fax number of the supplier contact. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:10Abbreviation that identifies the country for the fax number of the supplier contact. -
FaxNumber: string
Title:
FaxMaximum Length:40Fax number of the supplier contact. -
FirstName: string
Title:
First NameMaximum Length:150First name of the supplier contact. -
InactiveDate: string
(date)
Title:
Inactive DateDate when the supplier contact is no longer active. -
JobTitle: string
Title:
Job TitleMaximum Length:100Job title of the supplier contact. -
LastName: string
Title:
Last NameMaximum Length:150Last name of the supplier contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the supplier contact row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the supplier contact row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiddleName: string
Title:
Middle NameMaximum Length:60Middle name of the supplier contact. -
MobileAreaCode: string
Title:
Mobile Area CodeMaximum Length:20Abbreviation that identifies the area for the mobile phone number of the supplier contact. -
MobileCountryCode: string
Title:
Mobile Country CodeMaximum Length:10Abbreviation that identifies the country for the mobile phone number of the supplier contact. -
MobileNumber: string
Title:
MobileMaximum Length:40Mobile phone number of the supplier contact. -
PersonProfileId: integer
(int64)
The unique identifier of the person profile.
-
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:20Abbreviation that identifies the area for the landline phone number of the supplier contact. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Abbreviation that identifies the country for the landline phone number of the supplier contact. -
PhoneExtension: string
Title:
Phone ExtensionMaximum Length:20Landline phone extension for the supplier contact. -
PhoneNumber: string
Title:
PhoneMaximum Length:40Landline phone number for the supplier contact. -
roles: array
Roles
Title:
RolesSupplier contact user roles are retrieved. -
Salutation: string
Title:
SalutationMaximum Length:80Honorific title of the supplier contact. -
SalutationCode: string
Title:
SalutationMaximum Length:30Abbreviation 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:
StatusRead Only:trueMaximum Length:255Status of the supplier contact. Values are ACTIVE or INACTIVE. -
SupplierContactId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier contact. -
UserAccountStatus: string
Title:
User Account StatusRead Only:trueMaximum Length:255Status of the supplier user account. Values are ACTIVE, INACTIVE, or PROCESSING. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the user account for a supplier contact.
Nested Schema : Contact Addresses
Type:
arrayTitle:
Contact AddressesSupplier contact addresses are retrieved.
Show Source
Nested Schema : Data Access
Type:
arrayTitle:
Data AccessData access of supplier contacts.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Roles
Type:
arrayTitle:
RolesSupplier contact user roles are retrieved.
Show Source
Nested Schema : suppliers-contacts-addresses-item-response
Type:
Show Source
object-
AddressName: string
Title:
Address NameMaximum Length:255Name of the supplier address associated with a supplier contact. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who associated the supplier address with a supplier contact. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the application associated the supplier address with a supplier contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the supplier address and supplier contact association row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the supplier address and supplier contact association row. -
links: array
Links
Title:
LinksThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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-dataaccess-item-response
Type:
Show Source
object-
AccessCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the data access of the supplier user. -
AccessValue: integer
(int64)
Read Only:
trueData access value of the supplier. -
Address: string
Title:
Address NameRead Only:trueMaximum Length:4000Name of the supplier site address. -
BUId: number
Title:
Procurement BURead Only:trueUnique identifier for the procurement BU of the site to which the supplier user has data access. -
BUName: string
Title:
Procurement BURead Only:trueMaximum Length:240Procurement BU of the site to which the supplier user has data access. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentSupplier: string
Title:
Parent SupplierRead Only:trueMaximum Length:360Parent supplier of the supplier to which the supplier user has data access. -
ParentSupplierId: number
Title:
Parent SupplierRead Only:trueUnique identifier for the parent supplier of the supplier to which the supplier user has data access. -
Supplier: string
Title:
SupplierRead Only:trueMaximum Length:360Name of the supplier for which the supplier has data access to. -
SupplierContactId: integer
(int64)
Read Only:
trueUnique identifier for the supplier contact for whom data access is being provisioned or updated. -
SupplierId: integer
(int64)
Title:
SupplierRead Only:trueUnique identifier for the supplier to which the supplier user has data access. -
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:240Supplier site to which the supplier user has data access. -
SupplierSiteId: number
Title:
Supplier SiteRead Only:trueUnique identifier for the supplier site to which the supplier user has data access.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : suppliers-contacts-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Enter Person InformationMaximum Length:30Enter Person Information -
__FLEX_Context_DisplayValue: string
Title:
Enter Person InformationEnter Person Information -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonProfileId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : suppliers-contacts-roles-item-response
Type:
Show Source
object-
Description: string
Title:
DescriptionMaximum Length:240Description of the role that the supplier contact has access to. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RoleId: integer
(int64)
Title:
RoleValue that uniquely identifies the role for which the supplier contact has access. -
RoleName: string
Title:
RoleMaximum Length:240Name of the role that the supplier contact has access to.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- SupplierContactId:
$request.path.SupplierContactId - SupplierId:
$request.path.SupplierId
- SupplierContactId:
- addresses
-
Parameters:
- SupplierContactId:
$request.path.SupplierContactId - SupplierId:
$request.path.SupplierId
Supplier contact addresses are retrieved. - SupplierContactId:
- dataaccess
-
Parameters:
- SupplierContactId:
$request.path.SupplierContactId - SupplierId:
$request.path.SupplierId
Data access of supplier contacts. - SupplierContactId:
- roles
-
Parameters:
- SupplierContactId:
$request.path.SupplierContactId - SupplierId:
$request.path.SupplierId
Supplier contact user roles are retrieved. - 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"
}
]
}