Jump to

• Request
• Response

Create an identifier association

post

/fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/identifiers

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssociationEndDate: string (date)
  The end or expiration date of the identifier association.
• AssociationStartDate: string (date)
  The start date of the identifier association.
• IdentifierId: integer (int64)
  The identifier that's associated.

{
    "type":"object",
    "properties":{
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the identifier association.",
            "format":"date",
            "nullable":false
        },
        "IdentifierId":{
            "type":"integer",
            "description":"The identifier that's associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end or expiration date of the identifier association.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : hedSystemOffices-identifiers-item-response

Type: object

Show Source

• AssociationEndDate: string (date)
  The end or expiration date of the identifier association.
• AssociationStartDate: string (date)
  The start date of the identifier association.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date the row was created.
• IdentifierAssociationId: integer (int64)
  Read Only: true

  The unique identifier for the contact association record.
• IdentifierId: integer (int64)
  The identifier that's associated.
• IdentifierMeaning: string
  Read Only: true

  Maximum Length: 80

  The identifier name or meaning.
• IdentifierName: string
  Read Only: true

  Maximum Length: 100

  The reference name of the identifier.
• IdentifierStatusCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The identifier status code for this identifier.
• IdentifierStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the default identifier status code for this identifier.
• IdentifierTypeCode: string
  Read Only: true

  Maximum Length: 30

  The identifier code for the associated identifier. This code isn't unique but used to describe and categorize the identifier.
• IdentifierValue: string
  Read Only: true

  Maximum Length: 50

  The alpha numeric value of the associated identifier.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  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.

{
    "type":"object",
    "properties":{
        "IdentifierTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier code for the associated identifier. This code isn't unique but used to describe and categorize the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierStatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the default identifier status code for this identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierValue":{
            "maxLength":"50",
            "type":"string",
            "description":"The alpha numeric value of the associated identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end or expiration date of the identifier association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IdentifierMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The identifier name or meaning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the identifier association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IdentifierStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier status code for this identifier.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IdentifierAssociationId":{
            "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
        },
        "IdentifierName":{
            "maxLength":"100",
            "type":"string",
            "description":"The reference name of the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierId":{
            "type":"integer",
            "description":"The identifier that's associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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

IdentifierStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{IdentifierStatusCode}%2CLookupType%3DORA_HER_IDENTIFIER_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: IdentifierStatusCode; Target Attribute: LookupType
• Display Attribute: Meaning

OrganizationIdentifierTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{IdentifierTypeCode}%2CLookupType%3DORA_HEY_ORG_ID_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top