Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier for the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ContactTitleCode":{
            "title":"Prefix",
            "maxLength":30,
            "type":"string",
            "description":"The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "ContactTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Department":{
            "maxLength":60,
            "type":"string",
            "description":"The department of the contact.",
            "nullable":true
        },
        "EmailAddress":{
            "maxLength":1000,
            "type":"string",
            "description":"The email for the contact.",
            "nullable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "FullName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The full name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "JobTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact.",
            "nullable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code of the contact.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code of the contact.",
            "nullable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if this is a primary contact.",
            "nullable":false
        }
    }
}

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 : externalOrganizations-contacts-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier for the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactTitleCode":{
            "title":"Prefix",
            "maxLength":30,
            "type":"string",
            "description":"The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "ContactTitleMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The contact title meaning of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The contact type meaning of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Department":{
            "maxLength":60,
            "type":"string",
            "description":"The department of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":1000,
            "type":"string",
            "description":"The email for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The full name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if this is a primary contact.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Links

HeyLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

PersonProfileLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/personProfileLookups

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

Back to Top