Update a business unit assignment
patch
/fscmRestApi/resources/11.13.18.05/businessUnitAssignments/{BusinessUnitAssignmentId}
Request
Path Parameters
-
BusinessUnitAssignmentId(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
-
AssignmentMethodTypeCode: string
Title:
Assignment Method Type Code
Maximum Length:30
Default Value:ORA_DIRECT
The method type of the assignment. -
BusinessUnitAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Unique identifier of the academic business unit settings assignment. -
BusinessUnitId: integer
Title:
Business Unit ID
The unique identifier of the academic business unit. -
RelatedObjectId: integer
(int64)
Title:
Related Entity ID
The unique identifier of the related entity. -
RelatedObjectTypeCode: string
Title:
Related Entity Type Code
Maximum Length:30
The entity type code of the related entity.
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 : businessUnitAssignments-item-response
Type:
Show Source
object
-
AcademicBusinessUnitName: string
Title:
Academic Business Unit Name
Read Only:true
Maximum Length:255
The name of the academic business unit. -
AssignmentMethodTypeCode: string
Title:
Assignment Method Type Code
Maximum Length:30
Default Value:ORA_DIRECT
The method type of the assignment. -
AssignmentMethodTypeMeaning: string
Title:
Assignment Method Type Name
Read Only:true
Maximum Length:80
The meaning of the assignment method type. -
BusinessUnitAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Unique identifier of the academic business unit settings assignment. -
BusinessUnitId: integer
Title:
Business Unit ID
The unique identifier of the academic business unit. -
Description: string
Title:
Academic Business Unit Description
Read Only:true
Maximum Length:255
The description of the academic business unit. -
EntityObjectId: integer
(int64)
Title:
Entity ID
The unique identifier of the academic entity. -
EntityObjectName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the academic entity. -
EntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
The entity type code of the academic entity. -
EntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The meaning of the entity type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelatedObjectId: integer
(int64)
Title:
Related Entity ID
The unique identifier of the related entity. -
RelatedObjectTypeCode: string
Title:
Related Entity Type Code
Maximum Length:30
The entity type code of the related entity. -
RelatedObjectTypeMeaning: string
Title:
Related Entity Type Name
Read Only:true
Maximum Length:80
The name of the related 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
- assignmentMethodTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_SETTINGS_ASSIGN_METHOD
The following properties are defined on the LOV link relation:- Source Attribute: AssignmentMethodTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- businessUnitsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicBusinessUnitName; Target Attribute: AcademicBusinessUnitName
- Display Attribute: AcademicBusinessUnitName
- entityTypesLOV
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: EntityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- relatedObjectTypesLOV
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: RelatedObjectTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: