Update a job title
patch
/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}
Request
Path Parameters
-
publicSectorJobTitlesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and JobTitleId ---for the Job Titles resource and used to uniquely identify an instance of Job Titles. The client should not generate the hash key value. Instead, the client should query on the Job Titles collection resource with a filter on the primary key values in order to navigate to a specific instance of Job Titles.
For example: publicSectorJobTitles?q=AgencyId=<value1>;JobTitleId=<value2>
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
-
BillRate: number
The bill rate for time recording.
-
BillRateFrequency: string
Maximum Length:
30
The bill rate frequency for time recording. -
CurrencyCode: string
Maximum Length:
3
The bill rate currency code for time recording. -
JobTitleDescription: string
Title:
Description
Maximum Length:100
The description of the job title. -
ValidFromDate: string
(date)
Title:
Valid From
The date from which the job title is available for use. -
ValidToDate: string
(date)
Title:
Valid To
The date until which the job title is available for use.
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 : publicSectorJobTitles-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
Identifier of the public sector agency. -
BillRate: number
The bill rate for time recording.
-
BillRateFrequency: string
Maximum Length:
30
The bill rate frequency for time recording. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
CurrencyCode: string
Maximum Length:
3
The bill rate currency code for time recording. -
JobTitleDescription: string
Title:
Description
Maximum Length:100
The description of the job title. -
JobTitleId: string
Title:
Job Title
Maximum Length:50
The unique identifier of the job title. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ValidFromDate: string
(date)
Title:
Valid From
The date from which the job title is available for use. -
ValidToDate: string
(date)
Title:
Valid To
The date until which the job title is available for use.
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.