Create a usage assignment
post
/crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment
Request
Path Parameters
-
PartyNumber(required): string
The unique alternate identifier for the person party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
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
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments of the usage assignment. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The user who created the module. -
EndDate: string
(date)
Title:
To Date
Indicates the date at the end of the date range within which the row is effective. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The unique identifier of party usage assigned to the party. -
StartDate: string
(date)
Title:
From Date
Indicates the date at the beginning of the date range within which the row is effective.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : hubPersons-UsageAssignment-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments of the usage assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The user who created the module. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
EndDate: string
(date)
Title:
To Date
Indicates the date at the end of the date range within which the row is effective. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of party that the party usage is assigned to. -
PartyUsageAssignmentId: integer
(int64)
Read Only:
true
The unique identifier for a party usage assignment. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The unique identifier of party usage assigned to the party. -
StartDate: string
(date)
Title:
From Date
Indicates the date at the beginning of the date range within which the row is effective. -
StatusFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:true
The internal use to soft delete 'from' assignment in transition rule. Assignment API won't expose this column. However, any query on assignment table should have status_flag = 'A'.
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
- PartyUsageLOV
-
Parameters:
- finder:
PartyUsageByTypeRowFinder%3BPartyUsageType%3DPERSON
The list of values indicating the party usage codes.
The following properties are defined on the LOV link relation:- Source Attribute: PartyUsageCode; Target Attribute: PartyUsageCode
- Display Attribute: PartyUsageName
- finder: