Update a student management organization identifier association
patch
/fscmRestApi/resources/11.13.18.05/hedOrganizationIdentifiers/{OrganizationIdentifierId}/child/identifierAssociations/{identifierAssociationsUniqID}
Request
Path Parameters
-
OrganizationIdentifierId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
identifierAssociationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Management Organization Identifier Associations resource and used to uniquely identify an instance of Student Management Organization Identifier Associations. The client should not generate the hash key value. Instead, the client should query on the Student Management Organization Identifier Associations collection resource in order to navigate to a specific instance of Student Management Organization Identifier Associations to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
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-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
- 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: