Jump to

• Request
• Response
• Examples

Update one contact

patch

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts/{SupplierContactId}

Request

Path Parameters

• SupplierContactId(required): integer(int64)
  Value that uniquely identifies the supplier contact.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "InactiveDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the supplier contact is no longer active.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            }
        },
        "addresses":{
            "title":"Contact Addresses",
            "type":"array",
            "description":"The Contact Addresses resource manages supplier contact addresses.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-addresses-item-patch-request"
            }
        },
        "FaxAreaCode":{
            "title":"Fax Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the fax of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Email":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "DFF":{
            "title":"Flexfields for Supplier Contacts",
            "type":"array",
            "description":"The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "MobileCountryCode":{
            "title":"Mobile Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the mobile phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "FaxCountryCode":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the fax of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "SalutationCode":{
            "title":"Salutation",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "AdministrativeContactFlag":{
            "title":"Administrative contact",
            "maxLength":255,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AdminContactRoleStatus"
                ]
            }
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":80,
            "type":"string",
            "description":"Honorific title of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"Job title of the supplier contact.",
            "nullable":true
        },
        "MobileAreaCode":{
            "title":"Mobile Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the mobile phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"Phone extension for the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "MobileNumber":{
            "title":"Mobile",
            "maxLength":40,
            "type":"string",
            "description":"Mobile phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":40,
            "type":"string",
            "description":"Fax of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"Phone for the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        }
    }
}

Nested Schema : Contact Addresses

Type: array

Title: Contact Addresses

The Contact Addresses resource manages supplier contact addresses.

Show Source

• Array of: object suppliers-contacts-addresses-item-patch-request

{
    "title":"Contact Addresses",
    "type":"array",
    "description":"The Contact Addresses resource manages supplier contact addresses.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-addresses-item-patch-request"
    }
}

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

• Array of: object suppliers-contacts-DFF-item-patch-request

{
    "title":"Flexfields for Supplier Contacts",
    "type":"array",
    "description":"The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : suppliers-contacts-addresses-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AddressName":{
            "title":"Address Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier address that is associated to the supplier contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AddressName1"
                ]
            }
        },
        "SupplierAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address that is associated to the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : suppliers-contacts-DFF-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Enter Person Information",
            "type":"string",
            "description":"Descriptive flexfield context display value for supplier sites.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Enter Person Information",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for supplier sites.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "addresses":{
            "title":"Contact Addresses",
            "type":"array",
            "description":"The Contact Addresses resource manages supplier contact addresses.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-addresses-item-response"
            }
        },
        "FaxAreaCode":{
            "title":"Fax Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the fax of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "DFF":{
            "title":"Flexfields for Supplier Contacts",
            "type":"array",
            "description":"The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.",
            "items":{
                "$ref":"#/components/schemas/suppliers-contacts-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MobileCountryCode":{
            "title":"Mobile Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the mobile phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxCountryCode":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the fax of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "SalutationCode":{
            "title":"Salutation",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AdministrativeContactFlag":{
            "title":"Administrative contact",
            "maxLength":255,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AdminContactRoleStatus"
                ]
            },
            "x-queryable":true
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":80,
            "type":"string",
            "description":"Honorific title of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"Job title of the supplier contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the country for the phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":40,
            "type":"string",
            "description":"Fax of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the supplier contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InactiveDate"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InactiveDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the supplier contact is no longer active.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "MobileAreaCode":{
            "title":"Mobile Area Code",
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the area for the mobile phone of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"Phone extension for the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "MobileNumber":{
            "title":"Mobile",
            "maxLength":40,
            "type":"string",
            "description":"Mobile phone number of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"Phone for the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the supplier contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Contact Addresses

Type: array

Title: Contact Addresses

The Contact Addresses resource manages supplier contact addresses.

Show Source

• Array of: object suppliers-contacts-addresses-item-response

{
    "title":"Contact Addresses",
    "type":"array",
    "description":"The Contact Addresses resource manages supplier contact addresses.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-addresses-item-response"
    }
}

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

• Array of: object suppliers-contacts-DFF-item-response

{
    "title":"Flexfields for Supplier Contacts",
    "type":"array",
    "description":"The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.",
    "items":{
        "$ref":"#/components/schemas/suppliers-contacts-DFF-item-response"
    },
    "x-cardinality":"1"
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierContactAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact address.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressName":{
            "title":"Address Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier address that is associated to the supplier contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AddressName1"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address that is associated to the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Nested Schema : suppliers-contacts-DFF-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Enter Person Information",
            "type":"string",
            "description":"Descriptive flexfield context display value for supplier sites.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Enter Person Information",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for supplier sites.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts/{SupplierContactId}/child/DFF

Parameters:

• SupplierContactId: $request.path.SupplierContactId
• SupplierId: $request.path.SupplierId

The Flexfields for Supplier Contacts resource manages supplier contact descriptive flexfields.

addresses

Operation: /fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts/{SupplierContactId}/child/addresses

Parameters:

• SupplierContactId: $request.path.SupplierContactId
• SupplierId: $request.path.SupplierId

The Contact Addresses resource manages supplier contact addresses.

Back to Top

Examples

This example describes how to update a supplier contact.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/contacts/SupplierContactId"

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

{ 
    "JobTitle": "Sales Manager",
   "AdministrativeContactFlag": false,
   "MobileCountryCode": "1",
   "MobileAreaCode": "312",
   "MobileNumber": "555-8890"
}

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": "Sales Manager",
    "AdministrativeContactFlag": false,
    "PhoneCountryCode": null,
    "PhoneAreaCode": null,
    "PhoneNumber": null,
    "PhoneExtension": null,
    "MobileCountryCode": "1",
    "MobileAreaCode": "312",
    "MobileNumber": "555-8890",
    "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000A77040000000A737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E0002000000037371007E0002000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C7371007E0002000000027371007E00020000000271007E00087371007E00020000000271007E000871007E000878"
            }
        },
        {
            "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"
        }
    ]
}

Back to Top