Update a job assignment override
patch
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}
Request
Path Parameters
-
JobAssignmentOverrideUniqID(required): string
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=
-
RevenuePlanUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BillPlanId and MajorVersion ---for the Revenue Plans resource and used to uniquely identify an instance of Revenue Plans. The client should not generate the hash key value. Instead, the client should query on the Revenue Plans collection resource with a filter on the primary key values in order to navigate to a specific instance of Revenue Plans.
For example: RevenuePlan?q=BillPlanId=<value1>;MajorVersion=<value2> -
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
BillingTitle: string
Title:
Billing Title Override
Maximum Length:80
Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the job assignment override is defined. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
The contract line for which the job assignment override is defined. -
EmailAddress: string
Title:
Email
Maximum Length:240
The email address for whom the job assignment override is defined. -
EndDateActive: string
(date)
Title:
End Date
The date to which a job assignment override applies. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices. -
JobCode: string
Title:
Job Code
The job code of the override being assigned to the person for this bill or revenue plan. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the override job being assigned to the person for this bill or revenue plan. -
JobName: string
Title:
Job Name
Maximum Length:240
The job name of the override being assigned to the person for this bill or revenue plan. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
The version of the contract containing this particular set of job assignment override details. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person for whom the job assignment override is defined. -
PersonName: string
Title:
Person
Maximum Length:2000
The person for whom the job assignment override is defined. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
The person number for whom the job assignment override is defined. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a job assignment override applies.
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 : contracts-RevenuePlan-JobAssignmentOverride-item-response
Type:
Show Source
object
-
BillingTitle: string
Title:
Billing Title Override
Maximum Length:80
Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Unique identifier of the contract line for which the job assignment override is defined. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
The contract line for which the job assignment override is defined. -
EmailAddress: string
Title:
Email
Maximum Length:240
The email address for whom the job assignment override is defined. -
EndDateActive: string
(date)
Title:
End Date
The date to which a job assignment override applies. -
ExternalReferenceKey: string
Title:
External Reference Key
Maximum Length:150
Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices. -
ExternalSourceKey: string
Title:
External Source Key
Maximum Length:150
Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices. -
JobAssignmentOverrideId: integer
(int64)
Title:
Job Assignment Override ID
The unique identifier of the job assignment override on the bill plan that identifies the negotiated job assigned to a specific person, rather than the normal job for that person. -
JobCode: string
Title:
Job Code
The job code of the override being assigned to the person for this bill or revenue plan. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier of the override job being assigned to the person for this bill or revenue plan. -
JobName: string
Title:
Job Name
Maximum Length:240
The job name of the override being assigned to the person for this bill or revenue plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Title:
Version
Default Value:1
The version of the contract containing this particular set of job assignment override details. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person for whom the job assignment override is defined. -
PersonName: string
Title:
Person
Maximum Length:2000
The person for whom the job assignment override is defined. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
The person number for whom the job assignment override is defined. -
StartDateActive: string
(date)
Title:
Start Date
The date from which a job assignment override applies.
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.