Update an associated entity
patch
/fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/associatedEntities/{EntityAssociationId}
Request
Path Parameters
-
EntityAssociationId(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=
-
InstitutionId(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
-
AssociatedEntityId: integer
The unique identifier of the associated entity.
-
AssociatedEntityTypeCode: string
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
-
AssociationEndDate: string
(date)
The end or expiration date of the entity association.
-
AssociationStartDate: string
(date)
The start date of the entity association.
-
EntityAssociationId: integer
(int64)
The unique identifier for the entity association record.
-
EntityRelationshipType: string
The code value for the relationship type.
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 : academicInstitutions-associatedEntities-item-response
Type:
Show Source
object
-
AssociatedEntityCode: string
Read Only:
true
The user defined identifier of the associated entity. -
AssociatedEntityId: integer
The unique identifier of the associated entity.
-
AssociatedEntityName: string
Read Only:
true
The name of the associated entity. -
AssociatedEntityStatusCode: string
Read Only:
true
The status code of the system office. This controls the availability of the system office for associations with other academic entities. -
AssociatedEntityStatusMeaning: string
Read Only:
true
Maximum Length:255
The status of the system office. -
AssociatedEntitySubTypeCode: string
Read Only:
true
The entity subtype code of the associated entity. -
AssociatedEntitySubTypeMeaning: string
Read Only:
true
The entity subtype of the associated entity. -
AssociatedEntityTypeCode: string
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
-
AssociatedEntityTypeMeaning: string
Read Only:
true
The entity type of the associated entity. -
AssociationEndDate: string
(date)
The end or expiration date of the entity association.
-
AssociationStartDate: string
(date)
The start date of the entity 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. -
Description: string
Read Only:
true
The description of the associated entity. -
EntityAssociationId: integer
(int64)
The unique identifier for the entity association record.
-
EntityRelationshipMeaning: string
Read Only:
true
The type of relationship the association represents. -
EntityRelationshipType: string
The code value for the relationship 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.
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
- EntityRelationshipTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{EntityRelationshipType}%2CLookupType%3DORA_HER_ENTITY_RELATION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: EntityRelationshipType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EntityTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{AssociatedEntityTypeCode}%2CLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AssociatedEntityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: