Create all student management organization identifiers
post
/fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers
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
Root Schema : schema
Type:
Show Source
object
-
identifierAssociations: array
Student Management Organization Identifier Associations
Title:
Student Management Organization Identifier Associations
The identifier associations resource is used to associate an organization identifier with an organization. -
IdentifierName(required): string
Maximum Length:
100
The name of the identifier value. -
IdentifierStatusCode: string
Title:
Identifier Status Code
Maximum Length:30
Default Value:ORA_ACTIVE
The identifier status code for the organization identifier. This code isn't unique but used to indicate the status of the identifier. A list of accepted values is defined in the lookup type ORA_HER_IDENTIFIER_STATUS. -
IdentifierValue(required): string
Title:
Identifier Value
Maximum Length:50
The alpha numeric value of the associated identifier. -
OrganizationIdentifierTypeCode(required): string
Title:
Identifier Type Code
Maximum Length:30
A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
Nested Schema : Student Management Organization Identifier Associations
Type:
array
Title:
Student Management Organization Identifier Associations
The identifier associations resource is used to associate an organization identifier with an organization.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AssociatedObjectId: integer
(int64)
Title:
Associated Object ID
The unique identifier of the associated object. -
AssociationEndDate: string
(date)
Title:
End Date
The end or expiration date of the identifier association. -
AssociationStartDate: string
(date)
Title:
Start Date
The start date of the identifier association. -
OrganizationCategoryCode: string
Title:
Organization Category Code
Maximum Length:30
Default Value:ORA_HER_EXTERNAL_ORG
A list of accepted values is defined in the lookup type ORA_HER_ORG_CATEGORY.
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.
Root Schema : hedOrganizationIdentifiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
identifierAssociations: array
Student Management Organization Identifier Associations
Title:
Student Management Organization Identifier Associations
The identifier associations resource is used to associate an organization identifier with an organization. -
IdentifierName: string
Maximum Length:
100
The name of the identifier value. -
IdentifierStatusCode: string
Title:
Identifier Status Code
Maximum Length:30
Default Value:ORA_ACTIVE
The identifier status code for the organization identifier. This code isn't unique but used to indicate the status of the identifier. A list of accepted values is defined in the lookup type ORA_HER_IDENTIFIER_STATUS. -
IdentifierStatusMeaning: string
Title:
Identifier Status
Read Only:true
Maximum Length:80
The identifier status meaning. -
IdentifierValue: string
Title:
Identifier Value
Maximum Length:50
The alpha numeric value of the associated identifier. -
LastUpdateDate: string
(date-time)
Title:
Last Update 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. -
OrganizationIdentifierId: integer
(int64)
Title:
Organization Identifier ID
Read Only:true
The unique identifier for the organization identifier record. -
OrganizationIdentifierMeaning: string
Title:
Identifier Type
Read Only:true
Maximum Length:80
The identifier name or meaning. -
OrganizationIdentifierTypeCode: string
Title:
Identifier Type Code
Maximum Length:30
A list of accepted values is defined in the lookup type ORA_HEY_ORG_ID_TYPE.
Nested Schema : Student Management Organization Identifier Associations
Type:
array
Title:
Student Management Organization Identifier Associations
The identifier associations resource is used to associate an organization identifier with an organization.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedOrganizationIdentifiers-identifierAssociations-item-response
Type:
Show Source
object
-
AssociatedObjectId: integer
(int64)
Title:
Associated Object ID
The unique identifier of the associated object. -
AssociationEndDate: string
(date)
Title:
End Date
The end or expiration date of the identifier association. -
AssociationStartDate: string
(date)
Title:
Start Date
The start date of the identifier association. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
IdentifierAssociationId: integer
(int64)
Title:
Identifier Association ID
Read Only:true
The unique identifier for the contact association record. -
LastUpdateDate: string
(date-time)
Title:
Last Update 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. -
OrganizationCategoryCode: string
Title:
Organization Category Code
Maximum Length:30
Default Value:ORA_HER_EXTERNAL_ORG
A list of accepted values is defined in the lookup type ORA_HER_ORG_CATEGORY. -
OrganizationCategoryMeaning: string
Title:
Organization Category
Read Only:true
Maximum Length:80
The category name or meaning of the associated Student Management entity. -
OrganizationDescription: string
Title:
Organization Description
Read Only:true
Maximum Length:1000
The description of the associated organization. -
OrganizationName: string
Title:
Organization Name
Read Only:true
The name of the associated Student Management entity.
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.
Links
- IdentifierStatusLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{IdentifierStatusCode}%2CLookupType%3DORA_HER_IDENTIFIER_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: IdentifierStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OrganizationIdentifierTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{OrganizationIdentifierTypeCode}%2CLookupType%3DORA_HEY_ORG_ID_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationIdentifierTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- identifierAssociations
-
Parameters:
- OrganizationIdentifierId:
$request.path.OrganizationIdentifierId
The identifier associations resource is used to associate an organization identifier with an organization. - OrganizationIdentifierId: