Create a contact
post
/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts
Request
Path Parameters
-
PartyId(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:
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
-
ContactId: integer
(int64)
The unique identifier for the contact.
-
ContactTitleCode: string
Title:
Prefix
Maximum Length:30
The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. -
ContactTypeCode: string
Maximum Length:
30
The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
Department: string
Maximum Length:
60
The department of the contact. -
EmailAddress: string
Maximum Length:
1000
The email for the contact. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the contact. -
FullName: string
Title:
Name
Maximum Length:450
The full name of the contact. -
JobTitle: string
Maximum Length:
100
The job title of the contact. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the contact. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PrimaryFlag: boolean
Maximum Length:
1
Indicates if this is a primary contact.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : externalOrganizations-contacts-item-response
Type:
Show Source
object
-
ContactId: integer
(int64)
The unique identifier for the contact.
-
ContactTitleCode: string
Title:
Prefix
Maximum Length:30
The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. -
ContactTitleMeaning: string
Read Only:
true
Maximum Length:80
The contact title meaning of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE. -
ContactTypeCode: string
Maximum Length:
30
The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
ContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The contact type meaning of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
Department: string
Maximum Length:
60
The department of the contact. -
EmailAddress: string
Maximum Length:
1000
The email for the contact. -
EndDate: string
(date)
Read Only:
true
The end date of the contact. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the contact. -
FullName: string
Title:
Name
Maximum Length:450
The full name of the contact. -
JobTitle: string
Maximum Length:
100
The job title of the contact. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the contact. -
PhoneAreaCode: string
Maximum Length:
10
The area code of the contact. -
PhoneCountryCode: string
Maximum Length:
10
The country code of the contact. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact. -
PrimaryFlag: boolean
Maximum Length:
1
Indicates if this is a primary contact. -
StartDate: string
(date)
Read Only:
true
The start date of the contact.
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.
Links
- HeyLookupVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_ORG_CON_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ContactTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonProfileLookupVO
-
Parameters:
- finder:
LookupTypeIsActiveFinder%3BLookupType%3DCONTACT_TITLE
The following properties are defined on the LOV link relation:- Source Attribute: ContactTitleCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: