Jump to

• Request
• Response

Update an identifier

patch

/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers/{IdentifierId}

Request

Path Parameters

• IdentifierId(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=
• PartyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• OrganizationIdentifierCode: string
  Title: Identifier Type

  Maximum Length: 30

  The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
• OrganizationIdentifierValue: string
  Title: Identifier

  Maximum Length: 50

  The external organization identifier value issued by an external agency.

{
    "type":"object",
    "properties":{
        "OrganizationIdentifierCode":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationIdentifierValue":{
            "title":"Identifier",
            "maxLength":"50",
            "type":"string",
            "description":"The external organization identifier value issued by an external agency.",
            "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-identifiers-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who first created the row for the identifier.
• CreationDate: string (date-time)
  Read Only: true

  The date and time of the creation of the row for the identifier.
• EndDate: string (date)
  Read Only: true

  The end date of the identifier.
• IdentifierId: integer (int64)
  Read Only: true

  The identifier for the external organization identifier value.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• OrganizationIdentifierCode: string
  Title: Identifier Type

  Maximum Length: 30

  The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
• OrganizationIdentifierMeaning: string
  Read Only: true

  Maximum Length: 80

  The external organization identifier meaning. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
• OrganizationIdentifierValue: string
  Title: Identifier

  Maximum Length: 50

  The external organization identifier value issued by an external agency.
• StartDate: string (date)
  Read Only: true

  The start date of the identifier.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The start date of the identifier.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIdentifierMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The external organization identifier meaning. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIdentifierValue":{
            "title":"Identifier",
            "maxLength":"50",
            "type":"string",
            "description":"The external organization identifier value issued by an external agency.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationIdentifierCode":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the identifier.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierId":{
            "type":"integer",
            "description":"The identifier for the external organization identifier value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row for the identifier was 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

HeyLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_ORG_ID_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top