Jump to

• Request
• Response

Update a student management organization identifier

patch

/fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}

Request

Path Parameters

• OrganizationIdentifierId(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

• identifierAssociations: array Student Management Organization Identifier Associations
  Title: Student Management Organization Identifier Associations

  The identifier associations resource is used to associate an organization identifier with an organization.
• IdentifierName(required): string
  Maximum Length: 100

  The name of the identifier value.
• IdentifierStatusCode: string
  Title: Identifier Status Code

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The identifier status code for the organization identifier. This code isn't unique but used to indicate the status of the identifier. A list of accepted values is defined in the lookup type ORA_HER_IDENTIFIER_STATUS.
• IdentifierValue(required): string
  Title: Identifier Value

  Maximum Length: 50

  The alpha numeric value of the associated identifier.
• OrganizationIdentifierTypeCode(required): string
  Title: Identifier Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.

{
    "required":[
        "IdentifierName",
        "IdentifierValue",
        "OrganizationIdentifierTypeCode"
    ],
    "type":"object",
    "properties":{
        "identifierAssociations":{
            "title":"Student Management Organization Identifier Associations",
            "type":"array",
            "description":"The identifier associations resource is used to associate an organization identifier with an organization.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationIdentifiers-identifierAssociations-item-patch-request"
            }
        },
        "IdentifierValue":{
            "title":"Identifier Value",
            "maxLength":"50",
            "type":"string",
            "description":"The alpha numeric value of the associated identifier.",
            "nullable":false
        },
        "OrganizationIdentifierTypeCode":{
            "title":"Identifier Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IdentifierStatusCode":{
            "title":"Identifier Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier status code for the organization identifier. This code isn't unique but used to indicate the status of the identifier. A list of accepted values is defined in the lookup type ORA_HER_IDENTIFIER_STATUS.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IdentifierName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the identifier value.",
            "nullable":false
        }
    }
}

Nested Schema : Student Management Organization Identifier Associations

Type: array

Title: Student Management Organization Identifier Associations

The identifier associations resource is used to associate an organization identifier with an organization.

Show Source

• Array of: object schema

{
    "title":"Student Management Organization Identifier Associations",
    "type":"array",
    "description":"The identifier associations resource is used to associate an organization identifier with an organization.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationIdentifiers-identifierAssociations-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AssociationEndDate: string (date)
  Title: End Date

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

  The start date of the identifier association.
• OrganizationCategoryCode: string
  Title: Organization Category Code

  Maximum Length: 30

  Default Value: ORA_HER_EXTERNAL_ORG

  A list of accepted values is defined in the lookup type ORA_HER_ORG_CATEGORY.

{
    "type":"object",
    "properties":{
        "AssociationStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the identifier association.",
            "format":"date",
            "nullable":false
        },
        "OrganizationCategoryCode":{
            "title":"Organization Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ORG_CATEGORY.",
            "nullable":false,
            "default":"ORA_HER_EXTERNAL_ORG",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssociationEndDate":{
            "title":"End Date",
            "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 : hedOrganizationIdentifiers-item-response

Type: object

Show Source

• 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.
• identifierAssociations: array Student Management Organization Identifier Associations
  Title: Student Management Organization Identifier Associations

  The identifier associations resource is used to associate an organization identifier with an organization.
• IdentifierName: string
  Maximum Length: 100

  The name of the identifier value.
• IdentifierStatusCode: string
  Title: Identifier Status Code

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The identifier status code for the organization identifier. This code isn't unique but used to indicate the status of the identifier. A list of accepted values is defined in the lookup type ORA_HER_IDENTIFIER_STATUS.
• IdentifierStatusMeaning: string
  Title: Identifier Status

  Read Only: true

  Maximum Length: 80

  The identifier status meaning.
• IdentifierValue: string
  Title: Identifier Value

  Maximum Length: 50

  The alpha numeric value of the associated identifier.
• LastUpdateDate: string (date-time)
  Title: Last Update 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.
• OrganizationIdentifierId: integer (int64)
  Title: Organization Identifier ID

  Read Only: true

  The unique identifier for the organization identifier record.
• OrganizationIdentifierMeaning: string
  Title: Identifier Type

  Read Only: true

  Maximum Length: 80

  The identifier name or meaning.
• OrganizationIdentifierTypeCode: string
  Title: Identifier Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierStatusMeaning":{
            "title":"Identifier Status",
            "maxLength":"80",
            "type":"string",
            "description":"The identifier status meaning.",
            "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
        },
        "IdentifierValue":{
            "title":"Identifier Value",
            "maxLength":"50",
            "type":"string",
            "description":"The alpha numeric value of the associated identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationIdentifierMeaning":{
            "title":"Identifier Type",
            "maxLength":"80",
            "type":"string",
            "description":"The identifier name or meaning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIdentifierTypeCode":{
            "title":"Identifier Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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
        },
        "identifierAssociations":{
            "title":"Student Management Organization Identifier Associations",
            "type":"array",
            "description":"The identifier associations resource is used to associate an organization identifier with an organization.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationIdentifiers-identifierAssociations-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationIdentifierId":{
            "title":"Organization Identifier ID",
            "type":"integer",
            "description":"The unique identifier for the organization identifier record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IdentifierStatusCode":{
            "title":"Identifier Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier status code for the organization identifier. This code isn't unique but used to indicate the status of the identifier. A list of accepted values is defined in the lookup type ORA_HER_IDENTIFIER_STATUS.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the identifier value.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Student Management Organization Identifier Associations

Type: array

Title: Student Management Organization Identifier Associations

The identifier associations resource is used to associate an organization identifier with an organization.

Show Source

• Array of: object hedOrganizationIdentifiers-identifierAssociations-item-response

{
    "title":"Student Management Organization Identifier Associations",
    "type":"array",
    "description":"The identifier associations resource is used to associate an organization identifier with an organization.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationIdentifiers-identifierAssociations-item-response"
    }
}

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 : hedOrganizationIdentifiers-identifierAssociations-item-response

Type: object

Show Source

• AssociatedObjectId: integer (int64)
  Title: Associated Object ID

  The unique identifier of the associated object.
• AssociationEndDate: string (date)
  Title: End Date

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

  The start date of the identifier association.
• 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.
• IdentifierAssociationId: integer (int64)
  Title: Identifier Association ID

  Read Only: true

  The unique identifier for the contact association record.
• LastUpdateDate: string (date-time)
  Title: Last Update 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.
• OrganizationCategoryCode: string
  Title: Organization Category Code

  Maximum Length: 30

  Default Value: ORA_HER_EXTERNAL_ORG

  A list of accepted values is defined in the lookup type ORA_HER_ORG_CATEGORY.
• OrganizationCategoryMeaning: string
  Title: Organization Category

  Read Only: true

  Maximum Length: 80

  The category name or meaning of the associated Student Management entity.
• OrganizationDescription: string
  Title: Organization Description

  Read Only: true

  Maximum Length: 1000

  The description of the associated organization.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  The name of the associated Student Management entity.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "type":"string",
            "description":"The name of the associated Student Management entity.",
            "nullable":false,
            "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "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
        },
        "OrganizationCategoryCode":{
            "title":"Organization Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ORG_CATEGORY.",
            "nullable":false,
            "default":"ORA_HER_EXTERNAL_ORG",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedObjectId":{
            "title":"Associated Object ID",
            "type":"integer",
            "description":"The unique identifier of the associated object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationDescription":{
            "title":"Organization Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the associated organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCategoryMeaning":{
            "title":"Organization Category",
            "maxLength":"80",
            "type":"string",
            "description":"The category name or meaning of the associated Student Management entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end or expiration date of the identifier association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Start Date",
            "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"
            }
        },
        "IdentifierAssociationId":{
            "title":"Identifier 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
        },
        "LastUpdateDate":{
            "title":"Last Update 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

IdentifierStatusLOV

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: LookupCode
• Display Attribute: Meaning

OrganizationIdentifierTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

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

The following properties are defined on the LOV link relation:

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

identifierAssociations

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations

Parameters:

• OrganizationIdentifierId: $request.path.OrganizationIdentifierId

The identifier associations resource is used to associate an organization identifier with an organization.

Back to Top