Jump to

• Request
• Response

Update an external organization

patch

/fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}

Request

Path Parameters

• hedExternalOrganizationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the External Organizations resource and used to uniquely identify an instance of External Organizations. The client should not generate the hash key value. Instead, the client should query on the External Organizations collection resource in order to navigate to a specific instance of External Organizations to get the hash key.

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

• contacts: array Contacts
  Title: Contacts

  The contacts resource is used to view all associated contacts.
• EndDate: string (date)
  Title: Effective End Date

  The end date of the organization.
• identifiers: array Identifiers
  Title: Identifiers

  The identifiers resource is used to view all associated identifiers.
• InheritCoursesFlag: boolean
  Title: Inherit courses from another organization

  Maximum Length: 1

  Default Value: false

  Indicates whether an organization can inherit external courses from another external organization.
• InheritEquivalenciesFlag: boolean
  Title: Inherit course equivalencies

  Maximum Length: 1

  Default Value: false

  Indicates whether an organization can inherit course equivalencies from another external organization.
• InheritFromOrganizationId: integer (int64)
  Title: Inherit from Organization ID

  The organization identifier for the external organization from which to inherit external courses.
• locations: array Locations
  Title: Locations

  The locations resource shows all associated locations.
• NationalAccreditingEntityCode: string
  Title: National Accrediting Entity Code

  Maximum Length: 30

  The unique code for the national accrediting entity.
• OrganizationCategoryCode: string
  Title: Organization Category Code

  Maximum Length: 30

  The unique identifier for the organization category.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 100

  The unique identifier for the organization.
• OrganizationDescription: string
  Title: Organization Description

  Maximum Length: 1000

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

  Maximum Length: 100

  The name for the organization.
• OrganizationPhysicalId: integer (int64)
  Title: Organization Physical ID

  The physical identifier of the organization.
• OrganizationStatusCode: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the external organization. This controls the availability of the external organization for use in the application.
• OrganizationTypeCode: string
  Title: Organization Type Code

  Maximum Length: 30

  The unique identifier for the organization type.
• PartyId: integer (int64)
  Title: Party ID

  The party ID associated with the external organization.
• RegionalAccreditingEntityCode: string
  Title: Regional Accrediting Entity Code

  Maximum Length: 30

  The unique code for the regional accrediting entity.
• SchoolTypeCode: string
  Maximum Length: 30

  The unique identifier for the school type.
• StartDate: string (date)
  Title: Effective Start Date

  The start date of the organization.
• TermTypeCode: string
  Title: Term Type Code

  Maximum Length: 30

  The unique identifier for the term type.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name for the organization.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OrganizationCategoryCode":{
            "title":"Organization Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the organization category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationPhysicalId":{
            "title":"Organization Physical ID",
            "type":"integer",
            "description":"The physical identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "InheritEquivalenciesFlag":{
            "title":"Inherit course equivalencies",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an organization can inherit course equivalencies from another external organization.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"The identifiers resource is used to view all associated identifiers.",
            "items":{
                "$ref":"#/components/schemas/hedExternalOrganizations-identifiers-item-patch-request"
            }
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the organization type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "TermTypeCode":{
            "title":"Term Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the term type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "InheritCoursesFlag":{
            "title":"Inherit courses from another organization",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an organization can inherit external courses from another external organization.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "EndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The end date of the organization.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OrganizationDescription":{
            "title":"Organization Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description for the organization.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "StartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The start date of the organization.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The party ID associated with the external organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "InheritFromOrganizationId":{
            "title":"Inherit from Organization ID",
            "type":"integer",
            "description":"The organization identifier for the external organization from which to inherit external courses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier for the organization.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OrganizationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the external organization. This controls the availability of the external organization for use in the application.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SchoolTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the school type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "NationalAccreditingEntityCode":{
            "title":"National Accrediting Entity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the national accrediting entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "RegionalAccreditingEntityCode":{
            "title":"Regional Accrediting Entity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the regional accrediting entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"The locations resource shows all associated locations.",
            "items":{
                "$ref":"#/components/schemas/hedExternalOrganizations-locations-item-patch-request"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is used to view all associated contacts.",
            "items":{
                "$ref":"#/components/schemas/hedExternalOrganizations-contacts-item-patch-request"
            }
        }
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is used to view all associated contacts.

Show Source

• Array of: object schema

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource is used to view all associated contacts.",
    "items":{
        "$ref":"#/components/schemas/hedExternalOrganizations-contacts-item-patch-request"
    }
}

Nested Schema : Identifiers

Type: array

Title: Identifiers

The identifiers resource is used to view all associated identifiers.

Show Source

• Array of: object schema

{
    "title":"Identifiers",
    "type":"array",
    "description":"The identifiers resource is used to view all associated identifiers.",
    "items":{
        "$ref":"#/components/schemas/hedExternalOrganizations-identifiers-item-patch-request"
    }
}

Nested Schema : Locations

Type: array

Title: Locations

The locations resource shows all associated locations.

Show Source

• Array of: object schema

{
    "title":"Locations",
    "type":"array",
    "description":"The locations resource shows all associated locations.",
    "items":{
        "$ref":"#/components/schemas/hedExternalOrganizations-locations-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AssociationEndDate: string (date)
  Title: End Date

  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  Title: 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":"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":"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)
  The end or expiration date of the identifier association.
• AssociationStartDate: string (date)
  The start date of the identifier association.
• IdentifierId: integer (int64)
  The identifier that's associated.

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

Nested Schema : schema

Type: object

Show Source

• AssociationEndDate: string (date)
  Title: End Date

  The end date of the location site association.
• AssociationStartDate: string (date)
  Title: 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":"Start Date",
            "type":"string",
            "description":"The start date of the location site association.",
            "format":"date",
            "nullable":false
        },
        "AssociationEndDate":{
            "title":"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 : hedExternalOrganizations-item-response

Type: object

Show Source

• contacts: array Contacts
  Title: Contacts

  The contacts resource is used to view all associated contacts.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the row was created.
• EndDate: string (date)
  Title: Effective End Date

  The end date of the organization.
• identifiers: array Identifiers
  Title: Identifiers

  The identifiers resource is used to view all associated identifiers.
• InheritCoursesFlag: boolean
  Title: Inherit courses from another organization

  Maximum Length: 1

  Default Value: false

  Indicates whether an organization can inherit external courses from another external organization.
• InheritEquivalenciesFlag: boolean
  Title: Inherit course equivalencies

  Maximum Length: 1

  Default Value: false

  Indicates whether an organization can inherit course equivalencies from another external organization.
• InheritFromOrganizationId: integer (int64)
  Title: Inherit from Organization ID

  The organization identifier for the external organization from which to inherit external courses.
• InheritFromOrganizationName: string
  Title: Inherit from Organization

  Read Only: true

  Maximum Length: 100

  The external organization from which to inherit external courses.
• 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.
• locations: array Locations
  Title: Locations

  The locations resource shows all associated locations.
• NationalAccreditingEntityCode: string
  Title: National Accrediting Entity Code

  Maximum Length: 30

  The unique code for the national accrediting entity.
• NationalAccreditingEntityMeaning: string
  Title: National Accrediting Entity

  Read Only: true

  Maximum Length: 80

  The national accrediting entity.
• OrganizationCategoryCode: string
  Title: Organization Category Code

  Maximum Length: 30

  The unique identifier for the organization category.
• OrganizationCategoryMeaning: string
  Read Only: true

  Maximum Length: 80

  The category for an organization.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 100

  The unique identifier for the organization.
• OrganizationDescription: string
  Title: Organization Description

  Maximum Length: 1000

  The description for the organization.
• OrganizationLogicalId: integer (int64)
  Title: Organization Logical ID

  The logical identifier of the organization.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 100

  The name for the organization.
• OrganizationPhysicalId: integer (int64)
  Title: Organization Physical ID

  The physical identifier of the organization.
• OrganizationStatusCode: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the external organization. This controls the availability of the external organization for use in the application.
• OrganizationStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The status of the external organization.
• OrganizationTypeCode: string
  Title: Organization Type Code

  Maximum Length: 30

  The unique identifier for the organization type.
• OrganizationTypeMeaning: string
  Title: Organization Type

  Read Only: true

  Maximum Length: 80

  The type of organization, such as school or sponsorship.
• PartyId: integer (int64)
  Title: Party ID

  The party ID associated with the external organization.
• PrimaryContactFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the person.
• PrimaryContactFullName: string
  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 150

  The last name of the person.
• PrimaryContactPartyId: integer (int64)
  Read Only: true

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

  Read Only: true

  The address formatted based on the country code.
• PrimaryLocationFormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The multiline display for the formatted address.
• RegionalAccreditingEntityCode: string
  Title: Regional Accrediting Entity Code

  Maximum Length: 30

  The unique code for the regional accrediting entity.
• RegionalAccreditingEntityMeaning: string
  Title: Regional Accrediting Entity

  Read Only: true

  Maximum Length: 80

  The regional accrediting entity.
• SchoolTypeCode: string
  Maximum Length: 30

  The unique identifier for the school type.
• SchoolTypeMeaning: string
  Title: School Type

  Read Only: true

  Maximum Length: 80

  The type of school, such as a community or secondary school.
• StartDate: string (date)
  Title: Effective Start Date

  The start date of the organization.
• TermTypeCode: string
  Title: Term Type Code

  Maximum Length: 30

  The unique identifier for the term type.
• TermTypeMeaning: string
  Title: Term Type

  Read Only: true

  Maximum Length: 80

  The term type, such as semester, quarter, or trimester.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name for the organization.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PrimaryLocationFormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationPhysicalId":{
            "title":"Organization Physical ID",
            "type":"integer",
            "description":"The physical identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InheritEquivalenciesFlag":{
            "title":"Inherit course equivalencies",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an organization can inherit course equivalencies from another external organization.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the organization type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PrimaryLocationFormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The address formatted based on the country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InheritCoursesFlag":{
            "title":"Inherit courses from another organization",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an organization can inherit external courses from another external organization.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InheritFromOrganizationName":{
            "title":"Inherit from Organization",
            "maxLength":"100",
            "type":"string",
            "description":"The external organization from which to inherit external courses.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationDescription":{
            "title":"Organization Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description for the organization.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TermTypeMeaning":{
            "title":"Term Type",
            "maxLength":"80",
            "type":"string",
            "description":"The term type, such as semester, quarter, or trimester.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The start date of the organization.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SchoolTypeMeaning":{
            "title":"School Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of school, such as a community or secondary school.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier for the organization.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the external organization. This controls the availability of the external organization for use in the application.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SchoolTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the school type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegionalAccreditingEntityCode":{
            "title":"Regional Accrediting Entity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the regional accrediting entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationStatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the external organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPartyId":{
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationTypeMeaning":{
            "title":"Organization Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of organization, such as school or sponsorship.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationCategoryCode":{
            "title":"Organization Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the organization category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"The identifiers resource is used to view all associated identifiers.",
            "items":{
                "$ref":"#/components/schemas/hedExternalOrganizations-identifiers-item-response"
            }
        },
        "PrimaryContactFullName":{
            "maxLength":"255",
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLogicalId":{
            "title":"Organization Logical ID",
            "type":"integer",
            "description":"The logical identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TermTypeCode":{
            "title":"Term Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the term type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The end date of the organization.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OrganizationCategoryMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The category for an organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NationalAccreditingEntityMeaning":{
            "title":"National Accrediting Entity",
            "maxLength":"80",
            "type":"string",
            "description":"The national accrediting entity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The party ID associated with the external organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InheritFromOrganizationId":{
            "title":"Inherit from Organization ID",
            "type":"integer",
            "description":"The organization identifier for the external organization from which to inherit external courses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RegionalAccreditingEntityMeaning":{
            "title":"Regional Accrediting Entity",
            "maxLength":"80",
            "type":"string",
            "description":"The regional accrediting entity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "NationalAccreditingEntityCode":{
            "title":"National Accrediting Entity Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the national accrediting entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"The locations resource shows all associated locations.",
            "items":{
                "$ref":"#/components/schemas/hedExternalOrganizations-locations-item-response"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is used to view all associated contacts.",
            "items":{
                "$ref":"#/components/schemas/hedExternalOrganizations-contacts-item-response"
            }
        },
        "PrimaryContactFirstName":{
            "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"
            },
            "x-queryable":true
        },
        "PrimaryContactLastName":{
            "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is used to view all associated contacts.

Show Source

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

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource is used to view all associated contacts.",
    "items":{
        "$ref":"#/components/schemas/hedExternalOrganizations-contacts-item-response"
    }
}

Nested Schema : Identifiers

Type: array

Title: Identifiers

The identifiers resource is used to view all associated identifiers.

Show Source

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

{
    "title":"Identifiers",
    "type":"array",
    "description":"The identifiers resource is used to view all associated identifiers.",
    "items":{
        "$ref":"#/components/schemas/hedExternalOrganizations-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

The locations resource shows all associated locations.

Show Source

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

{
    "title":"Locations",
    "type":"array",
    "description":"The locations resource shows all associated locations.",
    "items":{
        "$ref":"#/components/schemas/hedExternalOrganizations-locations-item-response"
    }
}

Nested Schema : hedExternalOrganizations-contacts-item-response

Type: object

Show Source

• AssociationEndDate: string (date)
  Title: End Date

  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  Title: 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: 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 job title for this contact.
• DefaultJobTitle: string
  Title: Default Job Title

  Read Only: true

  Maximum Length: 100

  The default department of this contact.
• Department: string
  Title: Department

  Maximum Length: 100

  The name of the department that the contact belongs to.
• EmailAddress: string
  Title: 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: 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: 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: First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 30

  The preferred name suffix of the person such as junior or senior.
• PreferredNameTitle: string
  Title: 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: Prefix

  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":"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":"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":{
                "controlType":"choice",
                "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":"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 department of this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"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":"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 job title for 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":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Prefix",
            "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":"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":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"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":"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":"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 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":"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 : 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 : hedExternalOrganizations-identifiers-item-response

Type: object

Show Source

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

  Maximum Length: 64

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

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

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

  Maximum Length: 80

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

  Maximum Length: 100

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

  Maximum Length: 30

  Default Value: ORA_ACTIVE

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

  Maximum Length: 80

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

  Maximum Length: 30

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

  Maximum Length: 50

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

  The date the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : hedExternalOrganizations-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: End Date

  The end date of the location site association.
• AssociationStartDate: string (date)
  Title: 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: Address

  Read Only: true

  The address formatted based on the country code.
• FormattedMultilineAddress: string
  Title: 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":"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":"Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssociationEndDate":{
            "title":"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":"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

contacts

Operation: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/contacts

Parameters:

• hedExternalOrganizationsUniqID: $request.path.hedExternalOrganizationsUniqID

The contacts resource is used to view all associated contacts.

externalTermTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_EXT_TERM_TYPE%2CLookupCode%3D{TermTypeCode}

The following properties are defined on the LOV link relation:

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

identifiers

Operation: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/identifiers

Parameters:

• hedExternalOrganizationsUniqID: $request.path.hedExternalOrganizationsUniqID

The identifiers resource is used to view all associated identifiers.

locations

Operation: /fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}/child/locations

Parameters:

• hedExternalOrganizationsUniqID: $request.path.hedExternalOrganizationsUniqID

The locations resource shows all associated locations.

nationalAccreditingEntityLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{NationalAccreditingEntityCode}%2CLookupType%3DORA_HER_ORG_NAT_ACCRED_ENTITY

The following properties are defined on the LOV link relation:

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

organizationCategoryLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{OrganizationCategoryCode}%2CLookupType%3DORA_HER_ORG_CATEGORY

The following properties are defined on the LOV link relation:

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

organizationStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_EXTERNAL_ORG_STATUS%2CLookupCode%3D{OrganizationStatusCode}

The following properties are defined on the LOV link relation:

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

organizationTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{OrganizationTypeCode}%2CLookupType%3DORA_HEY_ORG_TYPE

The following properties are defined on the LOV link relation:

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

regionalAccreditingEntityLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_ORG_REG_ACCRED_ENTITY%2CLookupCode%3D{RegionalAccreditingEntityCode}

The following properties are defined on the LOV link relation:

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

schoolTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{SchoolTypeCode}%2CLookupType%3DORA_HER_EXT_SCHOOL_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top