Jump to

• Request
• Response

Create all academic institutions

post

/fscmRestApi/resources/11.13.18.05/academicInstitutions

Request

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• academicOrganizations: array Academic Organizations
  Title: Academic Organizations

  The academic organizations resource provides a list of academic organizations.
• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether the academic institution is active and available to use.
• associatedEntities: array Associated Academic Entities
  Title: Associated Academic Entities

  The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.
• campuses: array Campuses
  Title: Campuses

  The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is used to view all associated contacts.
• Description: string
  Maximum Length: 1000

  The description of the institution.
• EndDate(required): string (date)
  The end or expiration date of the academic institution.
• identifiers: array Identifiers
  Title: Identifiers

  The identifiers resource is used to view all associated identifiers.
• InstitutionCode: string
  Maximum Length: 100

  The code identifier of the institution.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for an academic institution.
• InstitutionName(required): string
  Title: Name

  Maximum Length: 100

  The name of the institution.
• InstitutionStatusCode: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the institution. This controls the availability of the institution for associations to other academic entities.
• InstitutionTypeCode: string
  Maximum Length: 30

  Indicates the type of academic institution. A list of accepted values is defined in the lookup type ORA_HER_INSTITUTION_TYPE.
• locations: array Locations
  Title: Locations

  The locations resource shows all associated locations.
• StartDate(required): string (date)
  The start date of the academic institution.
• subjects: array Subjects
  Title: Subjects

  The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.

{
    "required":[
        "EndDate",
        "InstitutionName",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the institution.",
            "nullable":true
        },
        "InstitutionName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the institution.",
            "nullable":false
        },
        "InstitutionStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the institution. This controls the availability of the institution for associations to other academic entities.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of academic institution. A list of accepted values is defined in the lookup type ORA_HER_INSTITUTION_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an academic institution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"The identifiers resource is used to view all associated identifiers.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-identifiers-item-post-request"
            }
        },
        "InstitutionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The code identifier of the institution.",
            "nullable":true
        },
        "subjects":{
            "title":"Subjects",
            "type":"array",
            "description":"The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-subjects-item-post-request"
            }
        },
        "academicOrganizations":{
            "title":"Academic Organizations",
            "type":"array",
            "description":"The academic organizations resource provides a list of academic organizations.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-item-post-request"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end or expiration date of the academic institution.",
            "format":"date",
            "nullable":false
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic institution is active and available to use.",
            "nullable":false,
            "default":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the academic institution.",
            "format":"date",
            "nullable":false
        },
        "associatedEntities":{
            "title":"Associated Academic Entities",
            "type":"array",
            "description":"The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-associatedEntities-item-post-request"
            }
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"The locations resource shows all associated locations.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-locations-item-post-request"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is used to view all associated contacts.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-contacts-item-post-request"
            }
        },
        "campuses":{
            "title":"Campuses",
            "type":"array",
            "description":"The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-campuses-item-post-request"
            }
        }
    }
}

Nested Schema : Academic Organizations

Type: array

Title: Academic Organizations

The academic organizations resource provides a list of academic organizations.

Show Source

• Array of: object academicInstitutions-academicOrganizations-item-post-request

{
    "title":"Academic Organizations",
    "type":"array",
    "description":"The academic organizations resource provides a list of academic organizations.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-item-post-request"
    }
}

Nested Schema : Associated Academic Entities

Type: array

Title: Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Show Source

• Array of: object academicInstitutions-associatedEntities-item-post-request

{
    "title":"Associated Academic Entities",
    "type":"array",
    "description":"The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-associatedEntities-item-post-request"
    }
}

Nested Schema : Campuses

Type: array

Title: Campuses

The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.

Show Source

• Array of: object academicInstitutions-campuses-item-post-request

{
    "title":"Campuses",
    "type":"array",
    "description":"The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-campuses-item-post-request"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is used to view all associated contacts.

Show Source

• Array of: object academicInstitutions-contacts-item-post-request

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

Nested Schema : Identifiers

Type: array

Title: Identifiers

The identifiers resource is used to view all associated identifiers.

Show Source

• Array of: object academicInstitutions-identifiers-item-post-request

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

Nested Schema : Subjects

Type: array

Title: Subjects

The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.

Show Source

• Array of: object academicInstitutions-subjects-item-post-request

{
    "title":"Subjects",
    "type":"array",
    "description":"The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-subjects-item-post-request"
    }
}

Nested Schema : academicInstitutions-academicOrganizations-item-post-request

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  The unique identifier for an academic organization.
• AcademicOrgName(required): string
  Title: Academic Organization

  Maximum Length: 50

  The name of the academic organization.
• AcademicOrgTypeCode: string
  Maximum Length: 30

  Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the academic organization is active and available to use.
• BusinessUnitId: integer (int64)
  Title: Business Unit

  The business unit associated with the academic organization.
• CampusId: integer (int64)
  Title: Campus ID

  The unique identifier for the campus associated with the academic organization.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the academic organization.
• EndDate(required): string (date)
  The end or expiration date of the academic organization.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for the academic institution associated with the academic organization.
• OrganizationCode: string
  Maximum Length: 100

  The code identifier of an academic organization.
• organizationStorefronts: array Offering Storefronts
  Title: Offering Storefronts

  The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.
• StartDate: string (date)
  The start date of the academic organization.
• StatusCode: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities.
• StorefrontOptionCode: string
  Title: Storefront

  Maximum Length: 30

  The storefront option code of the academic organization.

{
    "required":[
        "AcademicOrgName",
        "EndDate"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the academic organization.",
            "nullable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier for an academic organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for the academic institution associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "AcademicOrgName":{
            "title":"Academic Organization",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic organization.",
            "nullable":false
        },
        "BusinessUnitId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AcademicOrgTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end or expiration date of the academic organization.",
            "format":"date",
            "nullable":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic organization is active and available to use.",
            "nullable":true,
            "default":true
        },
        "organizationStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-organizationStorefronts-item-post-request"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the academic organization.",
            "format":"date",
            "nullable":false
        },
        "StorefrontOptionCode":{
            "title":"Storefront",
            "maxLength":30,
            "type":"string",
            "description":"The storefront option code of the academic organization.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier for the campus associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "OrganizationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The code identifier of an academic organization.",
            "nullable":true
        }
    }
}

Nested Schema : Offering Storefronts

Type: array

Title: Offering Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Show Source

• Array of: object academicInstitutions-academicOrganizations-organizationStorefronts-item-post-request

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-organizationStorefronts-item-post-request"
    }
}

Nested Schema : academicInstitutions-academicOrganizations-organizationStorefronts-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : academicInstitutions-associatedEntities-item-post-request

Type: object

Show Source

• AssociatedEntityId: integer
  The unique identifier of the associated entity.
• AssociatedEntityTypeCode: string
  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssociationEndDate: string (date)
  The end or expiration date of the entity association.
• AssociationStartDate: string (date)
  The start date of the entity association.
• EntityAssociationId: integer (int64)
  The unique identifier for the entity association record.
• EntityRelationshipType: string
  The code value for the relationship type.

{
    "type":"object",
    "properties":{
        "EntityAssociationId":{
            "type":"integer",
            "description":"The unique identifier for the entity association record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the entity association.",
            "format":"date",
            "nullable":false
        },
        "AssociatedEntityId":{
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "nullable":true
        },
        "AssociatedEntityTypeCode":{
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EntityRelationshipType":{
            "type":"string",
            "description":"The code value for the relationship type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end or expiration date of the entity association.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : academicInstitutions-campuses-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : academicInstitutions-contacts-item-post-request

Type: object

Show Source

• AssociationEndDate: string (date)
  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  The start date of the contact association.
• ContactPartyId: integer (int64)
  The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
• ContactTypeCode: string
  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
  Maximum Length: 100

  The name of the department that the contact belongs to.
• JobTitle: string
  Maximum Length: 100

  The job title of the associated contact.
• PrimaryContactFlag: boolean
  Maximum Length: 1

  Indicates that this person should be the primary contact.

{
    "type":"object",
    "properties":{
        "ContactTypeCode":{
            "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":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the department that the contact belongs to.",
            "nullable":true
        },
        "PrimaryContactFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this person should be the primary contact.",
            "nullable":false
        },
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the contact association.",
            "format":"date",
            "nullable":false
        },
        "ContactPartyId":{
            "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
            }
        },
        "JobTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end or expiration date of the contact association.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : academicInstitutions-identifiers-item-post-request

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)
  The end date of the location site association.
• AssociationStartDate: string (date)
  The start date of the location site association.
• LocationAssociationId: integer (int64)
  The unique identifier for the location association identifier.
• LocationId: integer (int64)
  The unique identifier of the location.
• PreferredAddressFlag: boolean
  Maximum Length: 1

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

{
    "type":"object",
    "properties":{
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier of the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationAssociationId":{
            "type":"integer",
            "description":"The unique identifier for the location association identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PreferredAddressFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":false
        },
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the location site association.",
            "format":"date",
            "nullable":false
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end date of the location site association.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : academicInstitutions-subjects-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : academicInstitutions-item-response

Type: object

Show Source

• academicOrganizations: array Academic Organizations
  Title: Academic Organizations

  The academic organizations resource provides a list of academic organizations.
• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether the academic institution is active and available to use.
• associatedEntities: array Associated Academic Entities
  Title: Associated Academic Entities

  The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.
• campuses: array Campuses
  Title: Campuses

  The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is used to view all associated contacts.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date the row was created.
• Description: string
  Maximum Length: 1000

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

  The identifiers resource is used to view all associated identifiers.
• InstitutionCode: string
  Maximum Length: 100

  The code identifier of the institution.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for an academic institution.
• InstitutionName: string
  Title: Name

  Maximum Length: 100

  The name of the institution.
• InstitutionStatusCode: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the institution. This controls the availability of the institution for associations to other academic entities.
• InstitutionStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The status of the institution.
• InstitutionTypeCode: string
  Maximum Length: 30

  Indicates the type of academic institution. A list of accepted values is defined in the lookup type ORA_HER_INSTITUTION_TYPE.
• InstitutionTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the academic institution type code. A list of accepted values is defined in the lookup type ORA_HER_INSTITUTION_TYPE.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• locations: array Locations
  Title: Locations

  The locations resource shows all associated locations.
• StartDate: string (date)
  The start date of the academic institution.
• subjects: array Subjects
  Title: Subjects

  The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the institution.",
            "nullable":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the institution.",
            "nullable":false,
            "x-queryable":true
        },
        "InstitutionStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the institution. This controls the availability of the institution for associations to other academic entities.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of academic institution. A list of accepted values is defined in the lookup type ORA_HER_INSTITUTION_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an academic institution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"The identifiers resource is used to view all associated identifiers.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-identifiers-item-response"
            }
        },
        "InstitutionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The code identifier of the institution.",
            "nullable":true,
            "x-queryable":true
        },
        "subjects":{
            "title":"Subjects",
            "type":"array",
            "description":"The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-subjects-item-response"
            }
        },
        "academicOrganizations":{
            "title":"Academic Organizations",
            "type":"array",
            "description":"The academic organizations resource provides a list of academic organizations.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-item-response"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end or expiration date of the academic institution.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic institution is active and available to use.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "InstitutionStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the institution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the academic institution.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "associatedEntities":{
            "title":"Associated Academic Entities",
            "type":"array",
            "description":"The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-associatedEntities-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "locations":{
            "title":"Locations",
            "type":"array",
            "description":"The locations resource shows all associated locations.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-locations-item-response"
            }
        },
        "InstitutionTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the academic institution type code. A list of accepted values is defined in the lookup type ORA_HER_INSTITUTION_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is used to view all associated contacts.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-contacts-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "campuses":{
            "title":"Campuses",
            "type":"array",
            "description":"The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-campuses-item-response"
            }
        }
    }
}

Nested Schema : Academic Organizations

Type: array

Title: Academic Organizations

The academic organizations resource provides a list of academic organizations.

Show Source

• Array of: object academicInstitutions-academicOrganizations-item-response

{
    "title":"Academic Organizations",
    "type":"array",
    "description":"The academic organizations resource provides a list of academic organizations.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-item-response"
    }
}

Nested Schema : Associated Academic Entities

Type: array

Title: Associated Academic Entities

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

Show Source

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

{
    "title":"Associated Academic Entities",
    "type":"array",
    "description":"The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-associatedEntities-item-response"
    }
}

Nested Schema : Campuses

Type: array

Title: Campuses

The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.

Show Source

• Array of: object academicInstitutions-campuses-item-response

{
    "title":"Campuses",
    "type":"array",
    "description":"The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-campuses-item-response"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is used to view all associated contacts.

Show Source

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

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

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

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

Nested Schema : Subjects

Type: array

Title: Subjects

The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.

Show Source

• Array of: object academicInstitutions-subjects-item-response

{
    "title":"Subjects",
    "type":"array",
    "description":"The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-subjects-item-response"
    }
}

Nested Schema : academicInstitutions-academicOrganizations-item-response

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  The unique identifier for an academic organization.
• AcademicOrgName: string
  Title: Academic Organization

  Maximum Length: 50

  The name of the academic organization.
• AcademicOrgTypeCode: string
  Maximum Length: 30

  Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
• AcademicOrgTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the academic organization type code. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the academic organization is active and available to use.
• BusinessUnitId: integer (int64)
  Title: Business Unit

  The business unit associated with the academic organization.
• CampusId: integer (int64)
  Title: Campus ID

  The unique identifier for the campus associated with the academic organization.
• CampusName: string
  Title: Campus

  Read Only: true

  The name of the campus associated with the academic organization.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 240

  The description of the academic organization.
• EndDate: string (date)
  The end or expiration date of the academic organization.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for the academic institution associated with the academic organization.
• InstitutionName: string
  Title: Institution

  Read Only: true

  The name of the institution associated with the academic organization.
• 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.
• OrganizationCode: string
  Maximum Length: 100

  The code identifier of an academic organization.
• organizationStorefronts: array Offering Storefronts
  Title: Offering Storefronts

  The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.
• StartDate: string (date)
  The start date of the academic organization.
• StatusCode: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

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

  Maximum Length: 80

  The status of the academic organization.
• StorefrontOptionCode: string
  Title: Storefront

  Maximum Length: 30

  The storefront option code of the academic organization.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the academic organization.",
            "nullable":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "type":"string",
            "description":"The name of the institution associated with the academic organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "InstitutionId"
                ]
            },
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier for an academic organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for the academic institution associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Academic Organization",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic organization.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Campus",
            "type":"string",
            "description":"The name of the campus associated with the academic organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "CampusId"
                ]
            },
            "x-queryable":true
        },
        "AcademicOrgTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end or expiration date of the academic organization.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic organization is active and available to use.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "organizationStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-organizationStorefronts-item-response"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the academic organization.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the academic organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StorefrontOptionCode":{
            "title":"Storefront",
            "maxLength":30,
            "type":"string",
            "description":"The storefront option code of the academic organization.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier for the campus associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The code identifier of an academic organization.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicOrgTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the academic organization type code. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : 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 : Offering Storefronts

Type: array

Title: Offering Storefronts

The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.

Show Source

• Array of: object academicInstitutions-academicOrganizations-organizationStorefronts-item-response

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-organizationStorefronts-item-response"
    }
}

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 : academicInstitutions-academicOrganizations-organizationStorefronts-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StorefrontId: integer (int64)
  Title: Storefront ID

  Read Only: true

  The unique identifier for the offering storefront.
• StorefrontName: string
  Title: Storefront Name

  Read Only: true

  The name of the offering storefront.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the offering storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "type":"string",
            "description":"The name of the offering storefront.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StorefrontId"
                ]
            },
            "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 : academicInstitutions-associatedEntities-item-response

Type: object

Show Source

• AssociatedEntityCode: string
  Read Only: true

  The user defined identifier of the associated entity.
• AssociatedEntityId: integer
  The unique identifier of the associated entity.
• AssociatedEntityName: string
  Read Only: true

  The name of the associated entity.
• AssociatedEntityStatusCode: string
  Read Only: true

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

  Maximum Length: 255

  The status of the system office.
• AssociatedEntitySubTypeCode: string
  Read Only: true

  The entity subtype code of the associated entity.
• AssociatedEntitySubTypeMeaning: string
  Read Only: true

  The entity subtype of the associated entity.
• AssociatedEntityTypeCode: string
  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssociatedEntityTypeMeaning: string
  Read Only: true

  The entity type of the associated entity.
• AssociationEndDate: string (date)
  The end or expiration date of the entity association.
• AssociationStartDate: string (date)
  The start date of the entity 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.
• Description: string
  Read Only: true

  The description of the associated entity.
• EntityAssociationId: integer (int64)
  The unique identifier for the entity association record.
• EntityRelationshipMeaning: string
  Read Only: true

  The type of relationship the association represents.
• EntityRelationshipType: string
  The code value for the relationship type.
• 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":{
        "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
        },
        "AssociatedEntityTypeMeaning":{
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityName":{
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"The description of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityCode":{
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntitySubTypeCode":{
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityRelationshipType":{
            "type":"string",
            "description":"The code value for the relationship type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end or expiration date of the entity association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssociatedEntityStatusCode":{
            "type":"string",
            "description":"The status code of the system office. This controls the availability of the system office for associations with other academic entities.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EntityAssociationId":{
            "type":"integer",
            "description":"The unique identifier for the entity association record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EntityRelationshipMeaning":{
            "type":"string",
            "description":"The type of relationship the association represents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStartDate":{
            "type":"string",
            "description":"The start date of the entity association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssociatedEntitySubTypeMeaning":{
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedEntityId":{
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociatedEntityTypeCode":{
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedEntityStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The status of the system office.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : 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 : academicInstitutions-campuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus ID

  Read Only: true

  The unique identifier for a campus.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 100

  The name of the campus.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the campus.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the campus.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the campus.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier for a campus.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 : academicInstitutions-contacts-item-response

Type: object

Show Source

• AssociationEndDate: string (date)
  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  The start date of the contact association.
• ContactAssociationId: integer (int64)
  Read Only: true

  The unique identifier for the contact association record.
• ContactPartyId: integer (int64)
  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
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The contact status code for this contact.
• ContactStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the contact status code for this contact.
• ContactTypeCode: string
  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
  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
  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.
• DefaultContactTypeCode: string
  Read Only: true

  Maximum Length: 30

  The default contact type code for this contact.
• DefaultContactTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the default contact type code for this contact.
• DefaultDepartment: string
  Read Only: true

  Maximum Length: 100

  The default job title for this contact.
• DefaultJobTitle: string
  Read Only: true

  Maximum Length: 100

  The default department of this contact.
• Department: string
  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• JobTitle: string
  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)
  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.
• 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
  Read Only: true

  Maximum Length: 20

  The area code within a country.
• PhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneNumber: string
  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
  Read Only: true

  Maximum Length: 150

  The preferred first name of a person.
• PreferredFullName: string
  Read Only: true

  Maximum Length: 360

  The preferred first and last name of the person displayed as a single string.
• PreferredLastName: string
  Read Only: true

  Maximum Length: 150

  The preferred last name of a person.
• PreferredMiddleName: string
  Read Only: true

  Maximum Length: 60

  The preferred middle name of a person.
• PreferredNameSuffix: string
  Read Only: true

  Maximum Length: 30

  The preferred name suffix of the person such as junior or senior.
• PreferredNameTitle: string
  Read Only: true

  Maximum Length: 60

  The preferred name title of the person such as Mr or Mrs.
• PrimaryContactFlag: boolean
  Maximum Length: 1

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

  Read Only: true

  Maximum Length: 60

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this person should be the primary contact.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredNameSuffix":{
            "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":{
            "maxLength":150,
            "type":"string",
            "description":"The preferred first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "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":{
            "maxLength":100,
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "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":{
            "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":{
            "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":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the department that the contact belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactStatusCode":{
            "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":{
            "maxLength":100,
            "type":"string",
            "description":"The default department of this contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "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":{
            "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":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "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
        },
        "DefaultDepartment":{
            "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":{
            "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":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The name title or prefix of the person such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PreferredLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The preferred last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "type":"string",
            "description":"The end or expiration date of the contact association.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultContactTypeMeaning":{
            "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":{
            "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":{
            "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":{
            "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":{
            "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":{
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The preferred middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : 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 : academicInstitutions-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 : academicInstitutions-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
  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: Meaning

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

  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
  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.
• FloorNumber: string
  Title: Floor

  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
  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)
  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.
• LocationAssociationId: integer (int64)
  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)
  The unique identifier of the location.
• LocationName: string
  Title: Location Name

  Read Only: true

  Maximum Length: 100

  The name of the location.
• LocationStatusCode: string
  Read Only: true

  Maximum Length: 30

  The status code of the location. This controls the availability of the location for assignments.
• LocationStatusMeaning: string
  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
  Maximum Length: 1

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

  Read Only: true

  Maximum Length: 60

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

  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":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "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":{
            "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":{
            "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",
            "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":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "title":"Meaning",
            "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":{
            "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":{
            "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",
            "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":{
            "type":"integer",
            "description":"The unique identifier of the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationStatusCode":{
            "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",
            "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":{
            "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
        },
        "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
        },
        "LocationAssociationId":{
            "type":"integer",
            "description":"The unique identifier for the location association identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssociationStartDate":{
            "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":{
            "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 : academicInstitutions-subjects-item-response

Type: object

Show Source

• AcadSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The unique code for an academic subject.
• AcadSubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The unique identifier for a subject.
• AcadSubjectName: string
  Title: Name

  Read Only: true

  Maximum Length: 100

  The name of the academic subject.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the academic subject.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AcadSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for a subject.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the academic subject.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcadSubjectName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcadSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for an academic subject.",
            "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

InstitutionStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{InstitutionStatusCode}%2CLookupType%3DORA_HER_INSTITUTION_STATUS

The following properties are defined on the LOV link relation:

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

InstitutionTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{InstitutionTypeCode}%2CLookupType%3DORA_HER_INSTITUTION_TYPE

The following properties are defined on the LOV link relation:

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

academicOrganizations

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations

Parameters:

• InstitutionId: $request.path.InstitutionId

The academic organizations resource provides a list of academic organizations.

associatedEntities

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities

Parameters:

• InstitutionId: $request.path.InstitutionId

The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.

campuses

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/campuses

Parameters:

• InstitutionId: $request.path.InstitutionId

The campuses resource is a child of the academic institutions resource and provides a complete list of campuses associated with an institution.

contacts

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/contacts

Parameters:

• InstitutionId: $request.path.InstitutionId

The contacts resource is used to view all associated contacts.

identifiers

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/identifiers

Parameters:

• InstitutionId: $request.path.InstitutionId

The identifiers resource is used to view all associated identifiers.

locations

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/locations

Parameters:

• InstitutionId: $request.path.InstitutionId

The locations resource shows all associated locations.

subjects

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/subjects

Parameters:

• InstitutionId: $request.path.InstitutionId

The subjects resource is a child of the academic institutions resource and provides a complete list of subjects associated with an institution.

Back to Top