Get an external organization
get
/fscmRestApi/resources/11.13.18.05/hedExternalOrganizations/{hedExternalOrganizationsUniqID}
Request
Path Parameters
-
hedExternalOrganizationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the External Organizations resource and used to uniquely identify an instance of External Organizations. The client should not generate the hash key value. Instead, the client should query on the External Organizations collection resource in order to navigate to a specific instance of External Organizations to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : hedExternalOrganizations-item-response
Type:
Show Source
object
-
contacts: array
Contacts
Title:
Contacts
The contacts resource is used to view all associated contacts. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Created On
Read Only:true
The date the row was created. -
EndDate: string
(date)
Title:
Effective End Date
The end date of the organization. -
identifiers: array
Identifiers
Title:
Identifiers
The identifiers resource is used to view all associated identifiers. -
InheritCoursesFlag: boolean
Title:
Inherit courses from another organization
Maximum Length:1
Default Value:false
Indicates whether an organization can inherit external courses from another external organization. -
InheritEquivalenciesFlag: boolean
Title:
Inherit course equivalencies
Maximum Length:1
Default Value:false
Indicates whether an organization can inherit course equivalencies from another external organization. -
InheritFromOrganizationId: integer
(int64)
Title:
Inherit from Organization ID
The organization identifier for the external organization from which to inherit external courses. -
InheritFromOrganizationName: string
Title:
Inherit from Organization
Read Only:true
Maximum Length:100
The external organization from which to inherit external courses. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locations: array
Locations
Title:
Locations
The locations resource shows all associated locations. -
NationalAccreditingEntityCode: string
Title:
National Accrediting Entity Code
Maximum Length:30
The unique code for the national accrediting entity. -
NationalAccreditingEntityMeaning: string
Title:
National Accrediting Entity
Read Only:true
Maximum Length:80
The national accrediting entity. -
OrganizationCategoryCode: string
Title:
Organization Category Code
Maximum Length:30
The unique identifier for the organization category. -
OrganizationCategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The category for an organization. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:100
The unique identifier for the organization. -
OrganizationDescription: string
Title:
Organization Description
Maximum Length:1000
The description for the organization. -
OrganizationLogicalId: integer
(int64)
Title:
Organization Logical ID
The logical identifier of the organization. -
OrganizationName: string
Title:
Organization Name
Maximum Length:100
The name for the organization. -
OrganizationPhysicalId: integer
(int64)
Title:
Organization Physical ID
The physical identifier of the organization. -
OrganizationStatusCode: string
Maximum Length:
30
Default Value:ORA_ACTIVE
The status code of the external organization. This controls the availability of the external organization for use in the application. -
OrganizationStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the external organization. -
OrganizationTypeCode: string
Title:
Organization Type Code
Maximum Length:30
The unique identifier for the organization type. -
OrganizationTypeMeaning: string
Title:
Organization Type
Read Only:true
Maximum Length:80
The type of organization, such as school or sponsorship. -
PartyId: integer
(int64)
Title:
Party ID
The party ID associated with the external organization. -
PrimaryContactFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
PrimaryContactFullName: string
Read Only:
true
Maximum Length:255
The first and last name of the person displayed as a single string. -
PrimaryContactLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
PrimaryContactPartyId: integer
(int64)
Read Only:
true
The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person. -
PrimaryLocationFormattedAddress: string
Title:
Address
Read Only:true
The address formatted based on the country code. -
PrimaryLocationFormattedMultilineAddress: string
Title:
Address
Read Only:true
The multiline display for the formatted address. -
RegionalAccreditingEntityCode: string
Title:
Regional Accrediting Entity Code
Maximum Length:30
The unique code for the regional accrediting entity. -
RegionalAccreditingEntityMeaning: string
Title:
Regional Accrediting Entity
Read Only:true
Maximum Length:80
The regional accrediting entity. -
SchoolTypeCode: string
Maximum Length:
30
The unique identifier for the school type. -
SchoolTypeMeaning: string
Title:
School Type
Read Only:true
Maximum Length:80
The type of school, such as a community or secondary school. -
StartDate: string
(date)
Title:
Effective Start Date
The start date of the organization. -
TermTypeCode: string
Title:
Term Type Code
Maximum Length:30
The unique identifier for the term type. -
TermTypeMeaning: string
Title:
Term Type
Read Only:true
Maximum Length:80
The term type, such as semester, quarter, or trimester.
Nested Schema : Contacts
Type:
array
Title:
Contacts
The contacts resource is used to view all associated contacts.
Show Source
Nested Schema : Identifiers
Type:
array
Title:
Identifiers
The identifiers resource is used to view all associated identifiers.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Locations
Type:
array
Title:
Locations
The locations resource shows all associated locations.
Show Source
Nested Schema : hedExternalOrganizations-contacts-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end or expiration date of the contact association.
-
AssociationStartDate: string
(date)
The start date of the contact association.
-
ContactAssociationId: integer
(int64)
Read Only:
true
The unique identifier for the contact association record. -
ContactPartyId: integer
(int64)
The unique identifier for the party. Party can be a person or an organization. Associated contacts are always a party of type person.
-
ContactStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_ACTIVE
The contact status code for this contact. -
ContactStatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the contact status code for this contact. -
ContactTypeCode: string
Maximum Length:
30
Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
ContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
DefaultContactTypeCode: string
Read Only:
true
Maximum Length:30
The default contact type code for this contact. -
DefaultContactTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the default contact type code for this contact. -
DefaultDepartment: string
Read Only:
true
Maximum Length:100
The default job title for this contact. -
DefaultJobTitle: string
Read Only:
true
Maximum Length:100
The default department of this contact. -
Department: string
Maximum Length:
100
The name of the department that the contact belongs to. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the contact. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The first and last name of the person displayed as a single string. -
JobTitle: string
Maximum Length:
100
The job title of the associated contact. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the person. -
NameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
The name suffix of the person such as junior or senior. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
The area code within a country. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PreferredFirstName: string
Read Only:
true
Maximum Length:150
The preferred first name of a person. -
PreferredFullName: string
Read Only:
true
Maximum Length:360
The preferred first and last name of the person displayed as a single string. -
PreferredLastName: string
Read Only:
true
Maximum Length:150
The preferred last name of a person. -
PreferredMiddleName: string
Read Only:
true
Maximum Length:60
The preferred middle name of a person. -
PreferredNameSuffix: string
Read Only:
true
Maximum Length:30
The preferred name suffix of the person such as junior or senior. -
PreferredNameTitle: string
Read Only:
true
Maximum Length:60
The preferred name title of the person such as Mr or Mrs. -
PrimaryContactFlag: boolean
Maximum Length:
1
Indicates that this person should be the primary contact. -
Title: string
Title:
Title
Read Only:true
Maximum Length:60
The name title or prefix of the person such as Mr or Mrs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : hedExternalOrganizations-identifiers-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
The end or expiration date of the identifier association.
-
AssociationStartDate: string
(date)
The start date of the identifier association.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
IdentifierAssociationId: integer
(int64)
Read Only:
true
The unique identifier for the contact association record. -
IdentifierId: integer
(int64)
The identifier that's associated.
-
IdentifierMeaning: string
Read Only:
true
Maximum Length:80
The identifier name or meaning. -
IdentifierName: string
Read Only:
true
Maximum Length:100
The reference name of the identifier. -
IdentifierStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_ACTIVE
The identifier status code for this identifier. -
IdentifierStatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the default identifier status code for this identifier. -
IdentifierTypeCode: string
Read Only:
true
Maximum Length:30
The identifier code for the associated identifier. This code isn't unique but used to describe and categorize the identifier. -
IdentifierValue: string
Read Only:
true
Maximum Length:50
The alpha numeric value of the associated identifier. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedExternalOrganizations-locations-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddressFour: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The fourth line for the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Read Only:true
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines, used in Japan. -
AddressOne: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
The first line for the address. -
AddressThree: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The third line for the address. -
AddressTwo: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
The second line for the address. -
AddressUseTypeCode: string
Read Only:
true
Maximum Length:30
The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AddressUseTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE. -
AssociationEndDate: string
(date)
The end date of the location site association.
-
AssociationStartDate: string
(date)
The start date of the location site association.
-
Building: string
Title:
Building
Read Only:true
Maximum Length:240
The building name or number at a given address. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city for the address. -
CountryCode: string
Title:
Country
Read Only:true
Maximum Length:2
The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Read Only:true
Maximum Length:60
The county of the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
FloorNumber: string
Title:
Floor
Read Only:true
Maximum Length:40
The floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The address formatted based on the country code. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The multiline display for the formatted address. -
HouseType: string
Title:
House Type
Read Only:true
Maximum Length:30
The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationAssociationId: integer
(int64)
The unique identifier for the location association identifier.
-
LocationDirections: string
Title:
Location Directions
Read Only:true
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
The unique identifier of the location.
-
LocationName: string
Title:
Location Name
Read Only:true
Maximum Length:100
The name of the location. -
LocationStatusCode: string
Read Only:
true
Maximum Length:30
The status code of the location. This controls the availability of the location for assignments. -
LocationStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the location. -
Position: string
Title:
Position
Read Only:true
Maximum Length:50
The primary direction such as North or East that's used to access the location. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code for the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Read Only:true
Maximum Length:20
The four digit extension to the United States postal code. -
PreferredAddressFlag: boolean
Maximum Length:
1
Indicates the preferred address. The default value is: false. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
The province of the address. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:60
The state of the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- contacts
-
Parameters:
- hedExternalOrganizationsUniqID:
$request.path.hedExternalOrganizationsUniqID
The contacts resource is used to view all associated contacts. - hedExternalOrganizationsUniqID:
- externalTermTypesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_EXT_TERM_TYPE%2CLookupCode%3D{TermTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: TermTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- identifiers
-
Parameters:
- hedExternalOrganizationsUniqID:
$request.path.hedExternalOrganizationsUniqID
The identifiers resource is used to view all associated identifiers. - hedExternalOrganizationsUniqID:
- locations
-
Parameters:
- hedExternalOrganizationsUniqID:
$request.path.hedExternalOrganizationsUniqID
The locations resource shows all associated locations. - hedExternalOrganizationsUniqID:
- nationalAccreditingEntityLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{NationalAccreditingEntityCode}%2CLookupType%3DORA_HER_ORG_NAT_ACCRED_ENTITY
The following properties are defined on the LOV link relation:- Source Attribute: NationalAccreditingEntityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- organizationCategoryLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{OrganizationCategoryCode}%2CLookupType%3DORA_HER_ORG_CATEGORY
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationCategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- organizationStatusLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_EXTERNAL_ORG_STATUS%2CLookupCode%3D{OrganizationStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- organizationTypesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{OrganizationTypeCode}%2CLookupType%3DORA_HEY_ORG_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- regionalAccreditingEntityLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HER_ORG_REG_ACCRED_ENTITY%2CLookupCode%3D{RegionalAccreditingEntityCode}
The following properties are defined on the LOV link relation:- Source Attribute: RegionalAccreditingEntityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- schoolTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{SchoolTypeCode}%2CLookupType%3DORA_HER_EXT_SCHOOL_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: SchoolTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: