Jump to

• Request
• Response

Create an external organization

post

/fscmRestApi/resources/11.13.18.05/externalOrganizations

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

• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if the external organization is active or inactive.
• addresses: array Addresses
  Title: Addresses

  The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.
• externalCourses: array External Courses
  Title: External Courses

  The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.
• externalSubjects: array External Subjects
  Title: External Subjects

  The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.
• identifiers: array Identifiers
  Title: Identifiers

  The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.
• nameHistory: array External Organization History Names
  Title: External Organization History Names

  The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.
• OrganizationName(required): string
  Title: Organization Name

  Maximum Length: 360

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

  Maximum Length: 30

  The code that indicates the type of external organization. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE.
• PartyId(required): integer (int64)
  Title: Party ID

  The unique identifier for the external organization.
• SchoolTypeCode: string
  Maximum Length: 30

  The code that indicates the type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.

{
    "required":[
        "OrganizationName",
        "PartyId"
    ],
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the external organization.",
            "nullable":false
        },
        "addresses":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-addresses-item-post-request"
            }
        },
        "nameHistory":{
            "title":"External Organization History Names",
            "type":"array",
            "description":"The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-nameHistory-item-post-request"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-identifiers-item-post-request"
            }
        },
        "externalSubjects":{
            "title":"External Subjects",
            "type":"array",
            "description":"The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-externalSubjects-item-post-request"
            }
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of external organization. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SchoolTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "externalCourses":{
            "title":"External Courses",
            "type":"array",
            "description":"The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-externalCourses-item-post-request"
            }
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the external organization is active or inactive.",
            "nullable":false,
            "default":true
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-contacts-item-post-request"
            }
        }
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.

Show Source

• Array of: object externalOrganizations-addresses-item-post-request

{
    "title":"Addresses",
    "type":"array",
    "description":"The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-addresses-item-post-request"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.

Show Source

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

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-contacts-item-post-request"
    }
}

Nested Schema : External Courses

Type: array

Title: External Courses

The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.

Show Source

• Array of: object externalOrganizations-externalCourses-item-post-request

{
    "title":"External Courses",
    "type":"array",
    "description":"The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-externalCourses-item-post-request"
    }
}

Nested Schema : External Subjects

Type: array

Title: External Subjects

The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.

Show Source

• Array of: object externalOrganizations-externalSubjects-item-post-request

{
    "title":"External Subjects",
    "type":"array",
    "description":"The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-externalSubjects-item-post-request"
    }
}

Nested Schema : Identifiers

Type: array

Title: Identifiers

The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.

Show Source

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

{
    "title":"Identifiers",
    "type":"array",
    "description":"The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-identifiers-item-post-request"
    }
}

Nested Schema : External Organization History Names

Type: array

Title: External Organization History Names

The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.

Show Source

• Array of: object externalOrganizations-nameHistory-item-post-request

{
    "title":"External Organization History Names",
    "type":"array",
    "description":"The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-nameHistory-item-post-request"
    }
}

Nested Schema : externalOrganizations-addresses-item-post-request

Type: object

Show Source

• AddrElementAttributeFive: string
  Title: Additional Address Element 5

  Maximum Length: 150

  The fifth additional address element.
• AddrElementAttributeFour: string
  Title: Additional Address Element 4

  Maximum Length: 150

  The fourth additional address element.
• AddrElementAttributeOne: string
  Title: Additional Address Element 1

  Maximum Length: 150

  The first additional address element.
• AddrElementAttributeThree: string
  Title: Additional Address Element 3

  Maximum Length: 150

  The third additional address element.
• AddrElementAttributeTwo: string
  Title: Additional Address Element 2

  Maximum Length: 150

  The second additional address element.
• AddressFour: string
  Title: Address Line 4

  Maximum Length: 240

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

  Maximum Length: 560

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The second line of the address.
• AddressUseTypeCode: string
  Title: Purpose

  Maximum Length: 30

  The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the address.
• City: string
  Title: City

  Maximum Length: 60

  The name of the city mentioned in the address.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the address.
• EndDate: string (date)
  Title: To Date

  The end date of the address.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the building in the address.
• HouseTypeCode: string
  Title: House Type

  Maximum Length: 30

  The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The location directions of the address.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  The name for the location in the address.
• Position: string
  Title: Position

  Maximum Length: 50

  The position of the address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

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

  Maximum Length: 20

  The postal plus four code of the address.
• PreferredFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates if this is a preferred address or not.
• Province: string
  Title: Province

  Maximum Length: 60

  The province code of the address.
• StartDate: string (date)
  Title: From Date

  The start date of the address.
• State: string
  Title: State

  Maximum Length: 60

  The state code of the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "HouseTypeCode":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the building in the address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The fifth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The start date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The third additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddressUseTypeCode":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"The name for the location in the address.",
            "nullable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "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
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The first additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Position":{
            "title":"Position",
            "maxLength":50,
            "type":"string",
            "description":"The position of the address.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The name of the city mentioned in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The location directions of the address.",
            "nullable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The second additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The fourth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The postal plus four code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "PreferredFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if this is a preferred address or not.",
            "nullable":false,
            "default":false
        }
    }
}

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

Type: object

Show Source

• ContactId: integer (int64)
  The unique identifier for the contact.
• ContactTitleCode: string
  Title: Prefix

  Maximum Length: 30

  The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.
• ContactTypeCode: string
  Maximum Length: 30

  The contact type code of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• Department: string
  Maximum Length: 60

  The department of the contact.
• EmailAddress: string
  Maximum Length: 1000

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

  Maximum Length: 150

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

  Maximum Length: 450

  The full name of the contact.
• JobTitle: string
  Maximum Length: 100

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

  Maximum Length: 150

  The last name of the contact.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the contact.
• PhoneAreaCode: string
  Maximum Length: 10

  The area code of the contact.
• PhoneCountryCode: string
  Maximum Length: 10

  The country code of the contact.
• PhoneNumber: string
  Maximum Length: 40

  The phone number of the contact.
• PrimaryFlag: boolean
  Maximum Length: 1

  Indicates if this is a primary contact.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if this is a primary contact.",
            "nullable":false
        },
        "ContactTitleCode":{
            "title":"Prefix",
            "maxLength":30,
            "type":"string",
            "description":"The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier for the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "JobTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact.",
            "nullable":true
        },
        "EmailAddress":{
            "maxLength":1000,
            "type":"string",
            "description":"The email for the contact.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code of the contact.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code of the contact.",
            "nullable":true
        },
        "ContactTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type code 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":60,
            "type":"string",
            "description":"The department of the contact.",
            "nullable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The full name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "HR_ATTRIBUTE":"Y"
            }
        }
    }
}

Nested Schema : externalOrganizations-externalCourses-item-post-request

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the subject is active or inactive.
• CourseIdentifier: string
  Maximum Length: 50

  Alternate unique identifier for the course defined for an external organization.
• CourseLevelCode: string
  Maximum Length: 30

  The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.
• CourseName: string
  Maximum Length: 50

  The name for the external course.
• CourseTypeCode: string
  Maximum Length: 30

  The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.
• CourseUnits: number
  The number of units earned in the course.
• Description: string
  Description for the external course.
• EffectiveEndDate: string (date)
  Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
• ExternalAcademicLevelCode: string
  Maximum Length: 30

  The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.
• ExternalCourseId: integer (int64)
  External subject unique identifier.
• ExternalCourseRowId: integer (int64)
  External subject unique identifier.
• ExternalSubjectId: integer (int64)
  External subject unique identifier.
• OrganizationId: integer (int64)
  External organization unique identifier that owns this subject.

{
    "type":"object",
    "properties":{
        "CourseName":{
            "maxLength":50,
            "type":"string",
            "description":"The name for the external course.",
            "nullable":false
        },
        "Description":{
            "type":"string",
            "description":"Description for the external course.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false
        },
        "ExternalCourseRowId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CourseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CourseLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"External organization unique identifier that owns this subject.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CourseIdentifier":{
            "maxLength":50,
            "type":"string",
            "description":"Alternate unique identifier for the course defined for an external organization.",
            "nullable":false
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subject is active or inactive.",
            "nullable":false
        },
        "CourseUnits":{
            "type":"number",
            "description":"The number of units earned in the course.",
            "nullable":true,
            "x-hints":{
                "precision":3,
                "scale":2
            }
        },
        "ExternalCourseId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExternalAcademicLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false
        },
        "ExternalSubjectId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : externalOrganizations-externalSubjects-item-post-request

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the course is active or inactive.
• Description: string
  Description for the external subject.
• ExternalSubjectId: integer (int64)
  External subject unique identifier.
• SubjectCode: string
  Maximum Length: 50

  Alternate unique identifier for the external subject defined for an external organization.
• SubjectName: string
  Maximum Length: 50

  The name for the external subject.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description for the external subject.",
            "nullable":true
        },
        "SubjectCode":{
            "maxLength":50,
            "type":"string",
            "description":"Alternate unique identifier for the external subject defined for an external organization.",
            "nullable":false
        },
        "SubjectName":{
            "maxLength":50,
            "type":"string",
            "description":"The name for the external subject.",
            "nullable":false
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the course is active or inactive.",
            "nullable":false
        },
        "ExternalSubjectId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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

Type: object

Show Source

• OrganizationIdentifierCode: string
  Title: Identifier Type

  Maximum Length: 30

  The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
• OrganizationIdentifierValue: string
  Title: Identifier

  Maximum Length: 50

  The external organization identifier value issued by an external agency.

{
    "type":"object",
    "properties":{
        "OrganizationIdentifierCode":{
            "title":"Identifier Type",
            "maxLength":30,
            "type":"string",
            "description":"The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationIdentifierValue":{
            "title":"Identifier",
            "maxLength":50,
            "type":"string",
            "description":"The external organization identifier value issued by an external agency.",
            "nullable":false
        }
    }
}

Nested Schema : externalOrganizations-nameHistory-item-post-request

Type: object

Show Source

• EffectiveEndDate: string (date)
  Indicates the date at the beginning of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Indicates the date at the end of the date range within which the row is effective.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  The name of the external organization.
• PartyId: integer (int64)
  The unique identifier for the external organization.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the external organization.",
            "nullable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false
        }
    }
}

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 : externalOrganizations-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if the external organization is active or inactive.
• addresses: array Addresses
  Title: Addresses

  The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.
• contacts: array Contacts
  Title: Contacts

  The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.
• externalCourses: array External Courses
  Title: External Courses

  The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.
• externalSubjects: array External Subjects
  Title: External Subjects

  The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.
• identifiers: array Identifiers
  Title: Identifiers

  The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• nameHistory: array External Organization History Names
  Title: External Organization History Names

  The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  The name of the external organization.
• OrganizationType: string
  Title: Organization Type

  Read Only: true

  Maximum Length: 80

  The type of the external organization, for example school or business. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE.
• OrganizationTypeCode: string
  Title: Organization Type Code

  Maximum Length: 30

  The code that indicates the type of external organization. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier for the external organization.
• SchoolType: string
  Read Only: true

  Maximum Length: 80

  The type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.
• SchoolTypeCode: string
  Maximum Length: 30

  The code that indicates the type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the external organization.",
            "nullable":false,
            "x-queryable":true
        },
        "addresses":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-addresses-item-response"
            }
        },
        "nameHistory":{
            "title":"External Organization History Names",
            "type":"array",
            "description":"The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-nameHistory-item-response"
            }
        },
        "identifiers":{
            "title":"Identifiers",
            "type":"array",
            "description":"The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-identifiers-item-response"
            }
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of external organization. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the external organization, for example school or business. A list of accepted values is defined in the lookup type ORA_HEY_ORG_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "externalCourses":{
            "title":"External Courses",
            "type":"array",
            "description":"The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-externalCourses-item-response"
            }
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the external organization is active or inactive.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SchoolType":{
            "maxLength":80,
            "type":"string",
            "description":"The type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "externalSubjects":{
            "title":"External Subjects",
            "type":"array",
            "description":"The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-externalSubjects-item-response"
            }
        },
        "SchoolTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of school of the organization, for example college. A list of accepted values is defined in the lookup type ORA_HER_EXT_SCHOOL_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.",
            "items":{
                "$ref":"#/components/schemas/externalOrganizations-contacts-item-response"
            }
        }
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.

Show Source

• Array of: object externalOrganizations-addresses-item-response

{
    "title":"Addresses",
    "type":"array",
    "description":"The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-addresses-item-response"
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.

Show Source

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

{
    "title":"Contacts",
    "type":"array",
    "description":"The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-contacts-item-response"
    }
}

Nested Schema : External Courses

Type: array

Title: External Courses

The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.

Show Source

• Array of: object externalOrganizations-externalCourses-item-response

{
    "title":"External Courses",
    "type":"array",
    "description":"The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-externalCourses-item-response"
    }
}

Nested Schema : External Subjects

Type: array

Title: External Subjects

The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.

Show Source

• Array of: object externalOrganizations-externalSubjects-item-response

{
    "title":"External Subjects",
    "type":"array",
    "description":"The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-externalSubjects-item-response"
    }
}

Nested Schema : Identifiers

Type: array

Title: Identifiers

The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.

Show Source

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

{
    "title":"Identifiers",
    "type":"array",
    "description":"The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-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 : External Organization History Names

Type: array

Title: External Organization History Names

The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.

Show Source

• Array of: object externalOrganizations-nameHistory-item-response

{
    "title":"External Organization History Names",
    "type":"array",
    "description":"The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.",
    "items":{
        "$ref":"#/components/schemas/externalOrganizations-nameHistory-item-response"
    }
}

Nested Schema : externalOrganizations-addresses-item-response

Type: object

Show Source

• AddrElementAttributeFive: string
  Title: Additional Address Element 5

  Maximum Length: 150

  The fifth additional address element.
• AddrElementAttributeFour: string
  Title: Additional Address Element 4

  Maximum Length: 150

  The fourth additional address element.
• AddrElementAttributeOne: string
  Title: Additional Address Element 1

  Maximum Length: 150

  The first additional address element.
• AddrElementAttributeThree: string
  Title: Additional Address Element 3

  Maximum Length: 150

  The third additional address element.
• AddrElementAttributeTwo: string
  Title: Additional Address Element 2

  Maximum Length: 150

  The second additional address element.
• AddressFour: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address.
• AddressId: integer (int64)
  Read Only: true

  The unique identifier for the address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The second line of the address.
• AddressUseTypeCode: string
  Title: Purpose

  Maximum Length: 30

  The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.
• AddressUseTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The use type meaning of the address, for example, home or business. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number in the address.
• City: string
  Title: City

  Maximum Length: 60

  The name of the city mentioned in the address.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address.
• County: string
  Title: County

  Maximum Length: 60

  The county of the address.
• EndDate: string (date)
  Title: To Date

  The end date of the address.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the building in the address.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted address.
• FormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The formatted multiline address.
• HouseTypeCode: string
  Title: House Type

  Maximum Length: 30

  The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• HouseTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The house type meaning of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

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

  Read Only: true

  The unique identifier for the location in the address.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  The name for the location in the address.
• Position: string
  Title: Position

  Maximum Length: 50

  The position of the address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

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

  Maximum Length: 20

  The postal plus four code of the address.
• PreferredFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates if this is a preferred address or not.
• Province: string
  Title: Province

  Maximum Length: 60

  The province code of the address.
• StartDate: string (date)
  Title: From Date

  The start date of the address.
• State: string
  Title: State

  Maximum Length: 60

  The state code of the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "HouseTypeCode":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the building in the address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The fifth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The start date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":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 third additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"The name for the location in the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":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,
            "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 first additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier for the address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The use type meaning of the address, for example, home or business. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":50,
            "type":"string",
            "description":"The position of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The house type meaning of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location in the address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The name of the city mentioned in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":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 location directions of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The second additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The fourth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The postal plus four code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if this is a preferred address or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : externalOrganizations-contacts-item-response

Type: object

Show Source

• ContactId: integer (int64)
  The unique identifier for the contact.
• ContactTitleCode: string
  Title: Prefix

  Maximum Length: 30

  The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.
• ContactTitleMeaning: string
  Read Only: true

  Maximum Length: 80

  The contact title meaning of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.
• ContactTypeCode: string
  Maximum Length: 30

  The contact type code 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 contact type meaning of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• Department: string
  Maximum Length: 60

  The department of the contact.
• EmailAddress: string
  Maximum Length: 1000

  The email for the contact.
• EndDate: string (date)
  Read Only: true

  The end date of the contact.
• FirstName: string
  Title: First Name

  Maximum Length: 150

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

  Maximum Length: 450

  The full name of the contact.
• JobTitle: string
  Maximum Length: 100

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

  Maximum Length: 150

  The last name of the contact.
• links: array Links
  Title: Links

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

  Maximum Length: 60

  The middle name of the contact.
• PhoneAreaCode: string
  Maximum Length: 10

  The area code of the contact.
• PhoneCountryCode: string
  Maximum Length: 10

  The country code of the contact.
• PhoneNumber: string
  Maximum Length: 40

  The phone number of the contact.
• PrimaryFlag: boolean
  Maximum Length: 1

  Indicates if this is a primary contact.
• StartDate: string (date)
  Read Only: true

  The start date of the contact.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if this is a primary contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactTitleCode":{
            "title":"Prefix",
            "maxLength":30,
            "type":"string",
            "description":"The contact title code of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "ContactTitleMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The contact title meaning of the contact. A list of accepted values is defined in the lookup type CONTACT_TITLE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier for the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The contact type meaning of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The job title of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":1000,
            "type":"string",
            "description":"The email for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type code 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":60,
            "type":"string",
            "description":"The department of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The full name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name",
                "HR_ATTRIBUTE":"Y"
            },
            "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 : externalOrganizations-externalCourses-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the subject is active or inactive.
• CourseIdentifier: string
  Maximum Length: 50

  Alternate unique identifier for the course defined for an external organization.
• CourseLevelCode: string
  Maximum Length: 30

  The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.
• CourseLevelMeaning: string
  Read Only: true

  Maximum Length: 80

  The course level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.
• CourseName: string
  Maximum Length: 50

  The name for the external course.
• CourseTypeCode: string
  Maximum Length: 30

  The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.
• CourseTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The course type meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.
• CourseUnits: number
  The number of units earned in the course.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time of the creation of the row for the identifier.
• Description: string
  Description for the external course.
• EffectiveEndDate: string (date)
  Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
• ExternalAcademicLevelCode: string
  Maximum Length: 30

  The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.
• ExternalAcademicLevelMeaning: string
  Read Only: true

  Maximum Length: 80

  The external academic level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.
• ExternalCourseId: integer (int64)
  External subject unique identifier.
• ExternalCourseRowId: integer (int64)
  External subject unique identifier.
• ExternalSubjectId: integer (int64)
  External subject unique identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  External organization unique identifier that owns this subject.
• SubjectCode: string
  Read Only: true

  Maximum Length: 50

  The external subject defined for an external organization associated with the external course.

{
    "type":"object",
    "properties":{
        "CourseName":{
            "maxLength":50,
            "type":"string",
            "description":"The name for the external course.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description for the external course.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalCourseRowId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CourseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CourseLevelMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The course level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalAcademicLevelMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The external academic level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"External organization unique identifier that owns this subject.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CourseIdentifier":{
            "maxLength":50,
            "type":"string",
            "description":"Alternate unique identifier for the course defined for an external organization.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subject is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "CourseUnits":{
            "type":"number",
            "description":"The number of units earned in the course.",
            "nullable":true,
            "x-hints":{
                "precision":3,
                "scale":2
            },
            "x-queryable":true
        },
        "SubjectCode":{
            "maxLength":50,
            "type":"string",
            "description":"The external subject defined for an external organization associated with the external course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The course type meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalCourseId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalAcademicLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date Effective Entity: indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalSubjectId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "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 : externalOrganizations-externalSubjects-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Indicates whether the course is active or inactive.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time of the creation of the row for the identifier.
• Description: string
  Description for the external subject.
• ExternalSubjectId: integer (int64)
  External subject unique identifier.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• SubjectCode: string
  Maximum Length: 50

  Alternate unique identifier for the external subject defined for an external organization.
• SubjectName: string
  Maximum Length: 50

  The name for the external subject.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description for the external subject.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectCode":{
            "maxLength":50,
            "type":"string",
            "description":"Alternate unique identifier for the external subject defined for an external organization.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectName":{
            "maxLength":50,
            "type":"string",
            "description":"The name for the external subject.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the course is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalSubjectId":{
            "type":"integer",
            "description":"External subject unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row for the identifier was 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 : externalOrganizations-identifiers-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time of the creation of the row for the identifier.
• EndDate: string (date)
  Read Only: true

  The end date of the identifier.
• IdentifierId: integer (int64)
  Read Only: true

  The identifier for the external organization identifier value.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• OrganizationIdentifierCode: string
  Title: Identifier Type

  Maximum Length: 30

  The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
• OrganizationIdentifierMeaning: string
  Read Only: true

  Maximum Length: 80

  The external organization identifier meaning. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
• OrganizationIdentifierValue: string
  Title: Identifier

  Maximum Length: 50

  The external organization identifier value issued by an external agency.
• StartDate: string (date)
  Read Only: true

  The start date of the identifier.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The start date of the identifier.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIdentifierMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The external organization identifier meaning. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIdentifierValue":{
            "title":"Identifier",
            "maxLength":50,
            "type":"string",
            "description":"The external organization identifier value issued by an external agency.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationIdentifierCode":{
            "title":"Identifier Type",
            "maxLength":30,
            "type":"string",
            "description":"The external organization identifier code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the identifier.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierId":{
            "type":"integer",
            "description":"The identifier for the external organization identifier value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row for the identifier was 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 : externalOrganizations-nameHistory-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time of the creation of the row for the identifier.
• EffectiveEndDate: string (date)
  Indicates the date at the beginning of the date range within which the row is effective.
• EffectiveStartDate: string (date)
  Indicates the date at the end of the date range within which the row is effective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  The name of the external organization.
• PartyId: integer (int64)
  The unique identifier for the external organization.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the external organization.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Indicates the date at the beginning of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Indicates the date at the end of the date range within which the row is effective.",
            "format":"date",
            "nullable":false,
            "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

HerLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

The following properties are defined on the LOV link relation:

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

HeyLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_ORG_TYPE

The following properties are defined on the LOV link relation:

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

addresses

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses

Parameters:

• PartyId: $request.path.PartyId

The addresses resource is a child of the external organizations resource and provides a list of addresses associated with an external organization.

contacts

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/contacts

Parameters:

• PartyId: $request.path.PartyId

The contacts resource is a child of the external organizations resource and provides a list of contacts associated with an external organization.

externalCourses

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses

Parameters:

• PartyId: $request.path.PartyId

The external courses resource is a child of the external organizations resource and provides a list of external courses associated with an external organization.

externalSubjects

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalSubjects

Parameters:

• PartyId: $request.path.PartyId

The external subjects resource is a child of the external organizations resource and provides a list of external subjects associated with an external organization.

identifiers

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/identifiers

Parameters:

• PartyId: $request.path.PartyId

The identifiers resource is a child of the external organizations resource and provides a list of external organization identifiers. These identifiers are issued by external agencies.

nameHistory

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/nameHistory

Parameters:

• PartyId: $request.path.PartyId

The external organization history names resource is a child of the external organizations resource and provides a list of previous names used for the external organization.

Back to Top