Jump to

• Request
• Response

Update a system office

patch

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

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• associatedEntities: array Associated Academic Entities
  Title: Associated Academic Entities

  Associated entities have a parent or child relationship to another entity in the entity hierarchy.
• contacts: array Contacts
  Title: Contacts

  Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.
• Description: string
  Maximum Length: 100

  The description of the system office.
• EndDate: string (date)
  The end or expiration date of the system office.
• identifiers: array Identifiers
  Title: Identifiers

  Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.
• locations: array Locations
  Title: Locations

  Locations are the physical places associated with an entity.
• StartDate: string (date)
  The start date of the system office.
• SystemOfficeCode: string
  Maximum Length: 100

  The user defined identifier of a system office.
• SystemOfficeId: integer (int64)
  The unique identifier of a system office.
• SystemOfficeName: string
  Maximum Length: 100

  The name of the system office.
• SystemOfficeStatusCode: string
  Maximum Length: 30

  The status code of the system office. This controls the availability of the system office for associations with other academic entities.
• SystemOfficeTypeCode: string
  Maximum Length: 30

  The type code of the system office. This attribute allows further categorization of the system office if needed. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_OFFICE_TYPE.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The start date of the system office.",
            "format":"date",
            "nullable":false
        },
        "associatedEntities":{
            "title":"Associated Academic Entities",
            "type":"array",
            "description":"Associated entities have a parent or child relationship to another entity in the entity hierarchy.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-associatedEntities-item-patch-request"
            }
        },
        "SystemOfficeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of a system office.",
            "nullable":false
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the system office.",
            "nullable":true
        },
        "SystemOfficeStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the system office. This controls the availability of the system office for associations with other academic entities.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-identifiers-item-patch-request"
            }
        },
        "SystemOfficeId":{
            "type":"integer",
            "description":"The unique identifier of a system office.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SystemOfficeName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the system office.",
            "nullable":false
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"Locations are the physical places associated with an entity.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-locations-item-patch-request"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end or expiration date of the system office.",
            "format":"date",
            "nullable":true
        },
        "SystemOfficeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type code of the system office. This attribute allows further categorization of the system office if needed. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_OFFICE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-contacts-item-patch-request"
            }
        }
    }
}

Nested Schema : Associated Academic Entities

Type: array

Title: Associated Academic Entities

Associated entities have a parent or child relationship to another entity in the entity hierarchy.

Show Source

• Array of: object hedSystemOffices-associatedEntities-item-patch-request

{
    "title":"Associated Academic Entities",
    "type":"array",
    "description":"Associated entities have a parent or child relationship to another entity in the entity hierarchy.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-associatedEntities-item-patch-request"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.

Show Source

• Array of: object schema

{
    "title":"Contacts",
    "type":"array",
    "description":"Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-contacts-item-patch-request"
    }
}

Nested Schema : Identifiers

Type: array

Title: Identifiers

Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.

Show Source

• Array of: object schema

{
    "title":"Identifiers",
    "type":"array",
    "description":"Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-identifiers-item-patch-request"
    }
}

Nested Schema : Locations

Type: array

Title: Locations

Locations are the physical places associated with an entity.

Show Source

• Array of: object hedSystemOffices-locations-item-patch-request

{
    "title":"Locations",
    "type":"array",
    "description":"Locations are the physical places associated with an entity.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-locations-item-patch-request"
    }
}

Nested Schema : hedSystemOffices-associatedEntities-item-patch-request

Type: object

Show Source

• AssociatedEntityId: integer (int64)
  Title: Associated Entity ID

  The unique identifier of the associated entity.
• AssociatedEntityTypeCode: string
  Title: Associated Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssociationEndDate: string (date)
  Title: Entity Association End Date

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

  The start date of the entity association.
• EntityRelationshipType: string
  Title: Entity Relationship Type Code

  Maximum Length: 30

  The code value for the relationship type.

{
    "type":"object",
    "properties":{
        "AssociationStartDate":{
            "title":"Entity Association Start Date",
            "type":"string",
            "description":"The start date of the entity association.",
            "format":"date",
            "nullable":false
        },
        "AssociatedEntityId":{
            "title":"Associated Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssociatedEntityTypeCode":{
            "title":"Associated Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EntityRelationshipType":{
            "title":"Entity Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code value for the relationship type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssociationEndDate":{
            "title":"Entity Association End Date",
            "type":"string",
            "description":"The end or expiration date of the entity association.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

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

  The start date of the contact association.
• ContactTypeCode: string
  Title: Contact Type Code

  Maximum Length: 30

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

  Maximum Length: 100

  The name of the department that the contact belongs to.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the associated contact.
• PrimaryContactFlag: boolean
  Title: Primary Contact

  Maximum Length: 1

  Indicates that this person should be the primary contact.

{
    "type":"object",
    "properties":{
        "ContactTypeCode":{
            "title":"Contact Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Department":{
            "title":"Department",
            "maxLength":100,
            "type":"string",
            "description":"The name of the department that the contact belongs to.",
            "nullable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this person should be the primary contact.",
            "nullable":false
        },
        "AssociationStartDate":{
            "title":"Contact Association Start Date",
            "type":"string",
            "description":"The start date of the contact association.",
            "format":"date",
            "nullable":false
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true
        },
        "AssociationEndDate":{
            "title":"Contact Association End Date",
            "type":"string",
            "description":"The end or expiration date of the contact association.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

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

  The start date of the identifier association.

{
    "type":"object",
    "properties":{
        "AssociationStartDate":{
            "title":"Identifier Association Start Date",
            "type":"string",
            "description":"The start date of the identifier association.",
            "format":"date",
            "nullable":false
        },
        "AssociationEndDate":{
            "title":"Identifier Association End Date",
            "type":"string",
            "description":"The end or expiration date of the identifier association.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : hedSystemOffices-locations-item-patch-request

Type: object

Show Source

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

  The end date of the location site association.
• AssociationStartDate: string (date)
  Title: Location Association Start Date

  The start date of the location site association.
• PreferredAddressFlag: boolean
  Title: Preferred Address

  Maximum Length: 1

  Indicates the preferred address. The default value is: false.

{
    "type":"object",
    "properties":{
        "PreferredAddressFlag":{
            "title":"Preferred Address",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":false
        },
        "AssociationStartDate":{
            "title":"Location Association Start Date",
            "type":"string",
            "description":"The start date of the location site association.",
            "format":"date",
            "nullable":false
        },
        "AssociationEndDate":{
            "title":"Location Association End Date",
            "type":"string",
            "description":"The end date of the location site 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-item-response

Type: object

Show Source

• associatedEntities: array Associated Academic Entities
  Title: Associated Academic Entities

  Associated entities have a parent or child relationship to another entity in the entity hierarchy.
• contacts: array Contacts
  Title: Contacts

  Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.
• 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.
• Description: string
  Maximum Length: 100

  The description of the system office.
• EndDate: string (date)
  The end or expiration date of the system office.
• identifiers: array Identifiers
  Title: Identifiers

  Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.
• 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.
• locations: array Locations
  Title: Locations

  Locations are the physical places associated with an entity.
• StartDate: string (date)
  The start date of the system office.
• SystemOfficeCode: string
  Maximum Length: 100

  The user defined identifier of a system office.
• SystemOfficeId: integer (int64)
  The unique identifier of a system office.
• SystemOfficeName: string
  Maximum Length: 100

  The name of the system office.
• SystemOfficeStatusCode: string
  Maximum Length: 30

  The status code of the system office. This controls the availability of the system office for associations with other academic entities.
• SystemOfficeStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The status of the system office.
• SystemOfficeTypeCode: string
  Maximum Length: 30

  The type code of the system office. This attribute allows further categorization of the system office if needed. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_OFFICE_TYPE.
• SystemOfficeTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The type of system office.

{
    "type":"object",
    "properties":{
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the system office.",
            "nullable":true,
            "x-queryable":true
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-identifiers-item-response"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end or expiration date of the system office.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SystemOfficeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type code of the system office. This attribute allows further categorization of the system office if needed. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_OFFICE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the system office.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "associatedEntities":{
            "title":"Associated Academic Entities",
            "type":"array",
            "description":"Associated entities have a parent or child relationship to another entity in the entity hierarchy.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-associatedEntities-item-response"
            }
        },
        "SystemOfficeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of a system office.",
            "nullable":false,
            "x-queryable":true
        },
        "SystemOfficeStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the system office.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemOfficeStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the system office. This controls the availability of the system office for associations with other academic entities.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SystemOfficeId":{
            "type":"integer",
            "description":"The unique identifier of a system office.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SystemOfficeName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the system office.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"Locations are the physical places associated with an entity.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-locations-item-response"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.",
            "items":{
                "$ref":"#/components/schemas/hedSystemOffices-contacts-item-response"
            }
        },
        "SystemOfficeTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The type of system office.",
            "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
        }
    }
}

Nested Schema : Associated Academic Entities

Type: array

Title: Associated Academic Entities

Associated entities have a parent or child relationship to another entity in the entity hierarchy.

Show Source

• Array of: object hedSystemOffices-associatedEntities-item-response

{
    "title":"Associated Academic Entities",
    "type":"array",
    "description":"Associated entities have a parent or child relationship to another entity in the entity hierarchy.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-associatedEntities-item-response"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.

Show Source

• Array of: object hedSystemOffices-contacts-item-response

{
    "title":"Contacts",
    "type":"array",
    "description":"Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-contacts-item-response"
    }
}

Nested Schema : Identifiers

Type: array

Title: Identifiers

Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.

Show Source

• Array of: object hedSystemOffices-identifiers-item-response

{
    "title":"Identifiers",
    "type":"array",
    "description":"Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-identifiers-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 : Locations

Type: array

Title: Locations

Locations are the physical places associated with an entity.

Show Source

• Array of: object hedSystemOffices-locations-item-response

{
    "title":"Locations",
    "type":"array",
    "description":"Locations are the physical places associated with an entity.",
    "items":{
        "$ref":"#/components/schemas/hedSystemOffices-locations-item-response"
    }
}

Nested Schema : hedSystemOffices-associatedEntities-item-response

Type: object

Show Source

• AssociatedEntityCode: string
  Title: Associated Entity Code

  Read Only: true

  Maximum Length: 50

  The user defined identifier of the associated entity.
• AssociatedEntityId: integer (int64)
  Title: Associated Entity ID

  The unique identifier of the associated entity.
• AssociatedEntityName: string
  Title: Associated Entity Name

  Read Only: true

  Maximum Length: 50

  The name of the associated entity.
• AssociatedEntityStatusCode: string
  Title: Associated Entity Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the associated entity. This controls the availability of the entity for associations with other academic entities.
• AssociatedEntityStatusMeaning: string
  Title: Associated Entity Status

  Read Only: true

  Maximum Length: 255

  The status of the associated entity.
• AssociatedEntitySubTypeCode: string
  Title: Associated Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• AssociatedEntitySubTypeMeaning: string
  Title: Associated Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• AssociatedEntityTypeCode: string
  Title: Associated Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssociatedEntityTypeMeaning: string
  Title: Associated Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• AssociationEndDate: string (date)
  Title: Entity Association End Date

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

  The start date of the entity association.
• CreatedBy: string
  Title: Entity Association Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the row was created.
• Description: string
  Title: Associated Entity Description

  Read Only: true

  Maximum Length: 240

  The description of the associated entity.
• EntityAssociationId: integer (int64)
  Title: Entity Association ID

  Read Only: true

  The unique identifier for the entity association record.
• EntityRelationshipMeaning: string
  Title: Entity Relationship Type

  Read Only: true

  Maximum Length: 80

  The type of relationship the association represents.
• EntityRelationshipType: string
  Title: Entity Relationship Type Code

  Maximum Length: 30

  The code value for the relationship type.
• LastUpdateDate: string (date-time)
  Title: Entity Association Last Updated Date

  Read Only: true

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Entity Association Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Entity Association Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityTypeMeaning":{
            "title":"Associated Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityName":{
            "title":"Associated Entity Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Associated Entity Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Entity Association Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityCode":{
            "title":"Associated Entity Code",
            "maxLength":50,
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntitySubTypeCode":{
            "title":"Associated Entity Subtype Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityRelationshipType":{
            "title":"Entity Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code value for the relationship type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"Entity Association End Date",
            "type":"string",
            "description":"The end or expiration date of the entity association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssociatedEntityStatusCode":{
            "title":"Associated Entity Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the associated entity. This controls the availability of the entity for associations with other academic entities.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EntityAssociationId":{
            "title":"Entity Association ID",
            "type":"integer",
            "description":"The unique identifier for the entity association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EntityRelationshipMeaning":{
            "title":"Entity Relationship Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of relationship the association represents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Entity Association Start Date",
            "type":"string",
            "description":"The start date of the entity 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"
            }
        },
        "AssociatedEntitySubTypeMeaning":{
            "title":"Associated Entity Subtype",
            "maxLength":80,
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityId":{
            "title":"Associated Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociatedEntityTypeCode":{
            "title":"Associated Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedEntityStatusMeaning":{
            "title":"Associated Entity Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Entity Association Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedSystemOffices-contacts-item-response

Type: object

Show Source

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

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

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

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

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

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 100

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

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 360

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

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 20

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

  Read Only: true

  Maximum Length: 10

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

  Read Only: true

  Maximum Length: 40

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 60

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

  Maximum Length: 1

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

  Read Only: true

  Maximum Length: 60

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedSystemOffices-identifiers-item-response

Type: object

Show Source

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

  The end or expiration date of the identifier association.
• AssociationStartDate: string (date)
  Title: Identifier Association 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 organization identifier association record.
• IdentifierId: integer (int64)
  Title: Identifier ID

  The identifier that's associated.
• IdentifierMeaning: string
  Title: Identifier Type

  Read Only: true

  Maximum Length: 80

  The identifier name or meaning.
• IdentifierName: string
  Title: Identifier Name

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The identifier status code for this identifier.
• IdentifierStatusMeaning: string
  Title: Identifier Status

  Read Only: true

  Maximum Length: 80

  The meaning of the default identifier status code for this identifier.
• IdentifierTypeCode: string
  Title: Identifier Type Code

  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
  Title: Identifier Value

  Read Only: true

  Maximum Length: 50

  The alpha numeric value of the associated identifier.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "IdentifierTypeCode":{
            "title":"Identifier Type Code",
            "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":{
            "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 meaning of the default identifier status code for this identifier.",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"Identifier Association End Date",
            "type":"string",
            "description":"The end or expiration date of the identifier association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IdentifierMeaning":{
            "title":"Identifier Type",
            "maxLength":80,
            "type":"string",
            "description":"The identifier name or meaning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Identifier Association 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"
            }
        },
        "IdentifierStatusCode":{
            "title":"Identifier Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The identifier status code for this identifier.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "IdentifierAssociationId":{
            "title":"Identifier Association ID",
            "type":"integer",
            "description":"The unique identifier for the organization identifier association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IdentifierName":{
            "title":"Identifier Name",
            "maxLength":100,
            "type":"string",
            "description":"The reference name of the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierId":{
            "title":"Identifier ID",
            "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 : hedSystemOffices-locations-item-response

Type: object

Show Source

• AddrElementAttributeFive: string
  Title: Additional Address Element 5

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeFour: string
  Title: Additional Address Element 4

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeOne: string
  Title: Additional Address Element 1

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeThree: string
  Title: Additional Address Element 3

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeTwo: string
  Title: Additional Address Element 2

  Read Only: true

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddressFour: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  The fourth line for the address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Read Only: true

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines, used in Japan.
• AddressOne: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line for the address.
• AddressThree: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  The third line for the address.
• AddressTwo: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line for the address.
• AddressUseTypeCode: string
  Title: Address Use Type Code

  Read Only: true

  Maximum Length: 30

  The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.
• AddressUseTypeMeaning: string
  Title: Address Use Type

  Read Only: true

  Maximum Length: 80

  The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.
• AssociationEndDate: string (date)
  Title: Location Association End Date

  The end date of the location site association.
• AssociationStartDate: string (date)
  Title: Location Association Start Date

  The start date of the location site association.
• Building: string
  Title: Building

  Read Only: true

  Maximum Length: 240

  The building name or number at a given address.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city for the address.
• CountryCode: string
  Title: Country Code

  Read Only: true

  Maximum Length: 2

  The country code from the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county of the address.
• 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.
• FloorNumber: string
  Title: Floor Number

  Read Only: true

  Maximum Length: 40

  The floor number at a given address or in a particular building when building number is provided.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  The address formatted based on the country code.
• FormattedMultilineAddress: string
  Title: Formatted Multiline Address

  Read Only: true

  The multiline display for the formatted address.
• HouseType: string
  Title: House Type

  Read Only: true

  Maximum Length: 30

  The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• HouseTypeMeaning: string
  Title: House Type

  Read Only: true

  Maximum Length: 80

  The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• LocationAssociationId: integer (int64)
  Title: Location Association ID

  Read Only: true

  The unique identifier for the location association identifier.
• LocationDirections: string
  Title: Location Directions

  Read Only: true

  Maximum Length: 640

  The directions to the location.
• LocationId: integer (int64)
  Title: Location ID

  The unique identifier of the location.
• LocationName: string
  Title: Location Name

  Read Only: true

  Maximum Length: 100

  The name of the location.
• LocationStatusCode: string
  Title: Location Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the location. This controls the availability of the location for assignments.
• LocationStatusMeaning: string
  Title: Location Status

  Read Only: true

  Maximum Length: 80

  The status of the location.
• Position: string
  Title: Position

  Read Only: true

  Maximum Length: 50

  The primary direction such as North or East that's used to access the location.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code for the address.
• PostalPlusFourCode: string
  Title: Postal Code Extension

  Read Only: true

  Maximum Length: 20

  The four digit extension to the United States postal code.
• PreferredAddressFlag: boolean
  Title: Preferred Address

  Maximum Length: 1

  Indicates the preferred address. The default value is: false.
• Province: string
  Title: Province Code

  Read Only: true

  Maximum Length: 60

  The province of the address.
• StateCode: string
  Title: State Code

  Read Only: true

  Maximum Length: 60

  The state of the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "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
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":40,
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PreferredAddressFlag":{
            "title":"Preferred Address",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":false,
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationName":{
            "title":"Location Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "title":"Address Use Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines, used in Japan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"The country code from the TERRITORY_CODE column in the FND_TERRITORY table.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationStatusMeaning":{
            "title":"Location Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the location.",
            "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
        },
        "AddressUseTypeMeaning":{
            "title":"Address Use Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "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
        },
        "Position":{
            "title":"Position",
            "maxLength":50,
            "type":"string",
            "description":"The primary direction such as North or East that's used to access the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "title":"House Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCode":{
            "title":"State Code",
            "maxLength":60,
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"The address formatted based on the country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier of the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationStatusCode":{
            "title":"Location Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the location. This controls the availability of the location for assignments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province Code",
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Formatted Multiline Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssociationEndDate":{
            "title":"Location Association End Date",
            "type":"string",
            "description":"The end date of the location site association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for the address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationAssociationId":{
            "title":"Location Association ID",
            "type":"integer",
            "description":"The unique identifier for the location association identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Location Association Start Date",
            "type":"string",
            "description":"The start date of the location site association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States postal code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

associatedEntities

Operation: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/associatedEntities

Parameters:

• SystemOfficeId: $request.path.SystemOfficeId

Associated entities have a parent or child relationship to another entity in the entity hierarchy.

contacts

Operation: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/contacts

Parameters:

• SystemOfficeId: $request.path.SystemOfficeId

Contacts store information like names, phone numbers, and email addresses for people who represent or have administrative duties for an entity.

identifiers

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

Parameters:

• SystemOfficeId: $request.path.SystemOfficeId

Identifiers are unique IDs assigned to entities by organizations like governments and regulatory bodies. They can be numeric or alphanumeric, and they may be assigned randomly or based on a system or taxonomy.

locations

Operation: /fscmRestApi/resources/11.13.18.05/hedSystemOffices/{SystemOfficeId}/child/locations

Parameters:

• SystemOfficeId: $request.path.SystemOfficeId

Locations are the physical places associated with an entity.

Back to Top