Jump to

• Request
• Response

Get an associated contact

get

/fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts/{ContactAssociationId}

Request

Path Parameters

• ContactAssociationId(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=
• hedExternalOrganizationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the External Organizations resource and used to uniquely identify an instance of External Organizations. The client should not generate the hash key value. Instead, the client should query on the External Organizations collection resource in order to navigate to a specific instance of External Organizations to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• AssociationEndDate: string (date)
  Title: Contact Association End Date

  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  Title: Contact Association Start Date

  The start date of the contact association.
• ContactAssociationId: integer (int64)
  Title: Contact Association ID

  Read Only: true

  The unique identifier for the contact association record.
• ContactPartyId: integer (int64)
  Title: Contact Party ID

  The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
• ContactStatusCode: string
  Title: Contact Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The contact status code for this contact.
• ContactStatusMeaning: string
  Title: Contact Status

  Read Only: true

  Maximum Length: 80

  The meaning of the contact status code for this contact.
• ContactTypeCode: string
  Title: Contact Type Code

  Maximum Length: 30

  Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• ContactTypeMeaning: string
  Title: Contact Type

  Read Only: true

  Maximum Length: 80

  The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• DefaultContactTypeCode: string
  Title: Default Contact Type Code

  Read Only: true

  Maximum Length: 30

  The default contact type code for this contact.
• DefaultContactTypeMeaning: string
  Title: Default Contact Type

  Read Only: true

  Maximum Length: 80

  The meaning of the default contact type code for this contact.
• DefaultDepartment: string
  Title: Default Department

  Read Only: true

  Maximum Length: 100

  The default department of this contact.
• DefaultJobTitle: string
  Title: Default Job Title

  Read Only: true

  Maximum Length: 100

  The default job title for this contact.
• Department: string
  Title: Department

  Maximum Length: 100

  The name of the department that the contact belongs to.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email address of the contact.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the person.
• FullName: string
  Title: Full Name

  Read Only: true

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the associated contact.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the person.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The middle name of the person.
• NameSuffix: string
  Title: Name Suffix

  Read Only: true

  Maximum Length: 30

  The name suffix of the person such as junior or senior.
• PhoneAreaCode: string
  Title: Area Code

  Read Only: true

  Maximum Length: 20

  The area code within a country.
• PhoneCountryCode: string
  Title: Country Code

  Read Only: true

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneNumber: string
  Title: Phone Number

  Read Only: true

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PreferredFirstName: string
  Title: Preferred First Name

  Read Only: true

  Maximum Length: 150

  The preferred first name of a person.
• PreferredFullName: string
  Title: Preferred Full Name

  Read Only: true

  Maximum Length: 360

  The preferred first and last name of the person displayed as a single string.
• PreferredLastName: string
  Title: Preferred Last Name

  Read Only: true

  Maximum Length: 150

  The preferred last name of a person.
• PreferredMiddleName: string
  Title: Preferred Middle Name

  Read Only: true

  Maximum Length: 60

  The preferred middle name of a person.
• PreferredNameSuffix: string
  Title: Preferred Name Suffix

  Read Only: true

  Maximum Length: 30

  The preferred name suffix of the person such as junior or senior.
• PreferredNameTitle: string
  Title: Preferred Title

  Read Only: true

  Maximum Length: 60

  The preferred name title of the person such as Mr or Mrs.
• PrimaryContactFlag: boolean
  Title: Primary Contact

  Maximum Length: 1

  Indicates that this person should be the primary contact.
• Title: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The name title or prefix of the person such as Mr or Mrs.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this person should be the primary contact.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredNameSuffix":{
            "title":"Preferred Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The preferred name suffix of the person such as junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFirstName":{
            "title":"Preferred First Name",
            "maxLength":150,
            "type":"string",
            "description":"The preferred first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Contact Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Contact Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type or usage 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
        },
        "Department":{
            "title":"Department",
            "maxLength":100,
            "type":"string",
            "description":"The name of the department that the contact belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactStatusCode":{
            "title":"Contact Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The contact status code for this contact.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The name suffix of the person such as junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DefaultJobTitle":{
            "title":"Default Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The default job title for this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredNameTitle":{
            "title":"Preferred Title",
            "maxLength":60,
            "type":"string",
            "description":"The preferred name title of the person such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultDepartment":{
            "title":"Default Department",
            "maxLength":100,
            "type":"string",
            "description":"The default department of this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DefaultContactTypeCode":{
            "title":"Default Contact Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The default contact type code for this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The name title or prefix of the person such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PreferredLastName":{
            "title":"Preferred Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The preferred last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"Contact Association End Date",
            "type":"string",
            "description":"The end or expiration date of the contact association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultContactTypeMeaning":{
            "title":"Default Contact Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the default contact type code for this contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":360,
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactStatusMeaning":{
            "title":"Contact Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the contact status code for this contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactAssociationId":{
            "title":"Contact Association ID",
            "type":"integer",
            "description":"The unique identifier for the contact association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Contact Association Start Date",
            "type":"string",
            "description":"The start date of the contact association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PreferredFullName":{
            "title":"Preferred Full Name",
            "maxLength":360,
            "type":"string",
            "description":"The preferred first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredMiddleName":{
            "title":"Preferred Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The preferred middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

ContactTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{ContactTypeCode}%2CLookupType%3DORA_HEY_ORG_CON_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: ContactTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

PhoneCountryCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedPhoneCountryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

Back to Top