Create all assignments
post
/fscmRestApi/resources/11.13.18.05/academicBuildings/{BuildingId}/child/assignments
Request
Path Parameters
-
BuildingId(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.
-
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
-
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodTypeCode: string
Maximum Length:
30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
The start date of the entity assignment. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_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 : academicBuildings-assignments-item-response
Type:
Show Source
object
-
AssignedEntityCode: string
Title:
Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
AssignedEntityStatusCode: string
Read Only:
true
Maximum Length:30
The status code of the entity. This controls the availability of the entity for assignments to settings. -
AssignedEntityStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the entity. -
AssignedEntitySubTypeCode: string
Title:
Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
AssignedEntitySubTypeMeaning: string
Title:
Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignedEntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodMeaning: string
Read Only:
true
Maximum Length:80
The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentMethodTypeCode: string
Maximum Length:
30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
The start date of the entity assignment. -
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. -
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. -
RelatedEntityCode: string
Read Only:
true
Maximum Length:100
The user defined identifier of the related entity. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityName: string
Read Only:
true
Maximum Length:100
The name of the related entity. -
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
RelatedEntityTypeMeaning: string
Read Only:
true
Maximum Length:80
The entity type of the related entity. -
SettingsAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Read Only:true
The unique identifier for the setup association record.
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
- AssignmentMethodTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{AssignmentMethodTypeCode}%2CLookupType%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:
- EntityCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AssignedEntityId; Target Attribute: AssociatedEntityId
- Display Attribute: AssociatedEntityName
- RelatedEntityTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{RelatedEntityTypeCode}%2CLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: RelatedEntityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- entityTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{AssignedEntityTypeCode}%2CLookupType%3DORA_HER_ASSOCIATED_OBJECT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AssignedEntityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: