Update an identifier association
patch
/fscmRestApi/resources/11.13.18.05/academicOrganizations/{AcademicOrgId}/child/identifiers/{IdentifierAssociationId}
Request
Path Parameters
-
AcademicOrgId(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=
-
IdentifierAssociationId(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=
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)
The end or expiration date of the identifier association.
-
AssociationStartDate: string
(date)
The start date of the identifier association.
-
IdentifierId: integer
(int64)
The identifier that's associated.
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 : academicOrganizations-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 : 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
- IdentifierStatusCodeLOV
-
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: LookupType
- Display Attribute: Meaning
- finder:
- OrganizationIdentifierTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{IdentifierTypeCode}%2CLookupType%3DORA_HEY_ORG_ID_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: IdentifierTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: