Jump to

• Request
• Response

Update a job title override

patch

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobTitleOverride/{JobTitleOverrideUniqID}

Request

Path Parameters

• BillPlanUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- BillPlanId and MajorVersion ---for the Bill Plans resource and used to uniquely identify an instance of Bill Plans. The client should not generate the hash key value. Instead, the client should query on the Bill Plans collection resource with a filter on the primary key values in order to navigate to a specific instance of Bill Plans.
  
  For example: BillPlan?q=BillPlanId=<value1>;MajorVersion=<value2>
• JobTitleOverrideUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- JobTitleOverrideId and MajorVersion ---for the Job Title Overrides resource and used to uniquely identify an instance of Job Title Overrides. The client should not generate the hash key value. Instead, the client should query on the Job Title Overrides collection resource with a filter on the primary key values in order to navigate to a specific instance of Job Title Overrides.
  
  For example: JobTitleOverride?q=JobTitleOverrideId=<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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BillingTitle: string
  Title: Billing Title Override

  Maximum Length: 80

  Name of the override job title being assigned to the job 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 title override is defined.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  The contract line number for which the job title override is defined.
• EndDateActive: string (date)
  Title: End Date

  The date to which a job title override applies.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.
• JobCode: string
  Title: Job Code

  Code of the job for which the job title override is defined.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier of the job for which the job title override is defined.
• JobName: string
  Title: Job Name

  Maximum Length: 240

  Name for the Job for which the job title override is defined.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Version of the contract containing this particular set of job title override details.
• StartDateActive: string (date)
  Title: Start Date

  The date from which a job title override applies.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Version of the contract containing this particular set of job title override details.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            }
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":"150",
            "type":"string",
            "description":"The contract line number for which the job title override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":"150",
            "type":"string",
            "description":"Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.",
            "nullable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which a job title override applies.",
            "format":"date",
            "nullable":false
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date to which a job title override applies.",
            "format":"date",
            "nullable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":"150",
            "type":"string",
            "description":"Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.",
            "nullable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"Code of the job for which the job title override is defined.",
            "nullable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the job title override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name for the Job for which the job title override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BillingTitle":{
            "title":"Billing Title Override",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the override job title being assigned to the job for this bill plan. Used to display on the invoice to the customer.",
            "nullable":false
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier of the job for which the job title override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : contracts-BillPlan-JobTitleOverride-item-response

Type: object

Show Source

• BillingTitle: string
  Title: Billing Title Override

  Maximum Length: 80

  Name of the override job title being assigned to the job 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 title override is defined.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  The contract line number for which the job title override is defined.
• EndDateActive: string (date)
  Title: End Date

  The date to which a job title override applies.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.
• JobCode: string
  Title: Job Code

  Code of the job for which the job title override is defined.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier of the job for which the job title override is defined.
• JobName: string
  Title: Job Name

  Maximum Length: 240

  Name for the Job for which the job title override is defined.
• JobTitleOverrideId: integer (int64)
  Title: Job Title Override ID

  Unique identifier of the job title override on the bill plan that identifies the negotiated job title assigned to a specific person, rather than the normal title for that person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Version of the contract containing this particular set of job title override details.
• StartDateActive: string (date)
  Title: Start Date

  The date from which a job title override applies.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Version of the contract containing this particular set of job title override details.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":"150",
            "type":"string",
            "description":"Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":"150",
            "type":"string",
            "description":"Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the job title override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name for the Job for which the job title override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillingTitle":{
            "title":"Billing Title Override",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the override job title being assigned to the job for this bill plan. Used to display on the invoice to the customer.",
            "nullable":false,
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":"150",
            "type":"string",
            "description":"The contract line number for which the job title override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which a job title override applies.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date to which a job title override applies.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"Code of the job for which the job title override is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "JobTitleOverrideId":{
            "title":"Job Title Override ID",
            "type":"integer",
            "description":"Unique identifier of the job title override on the bill plan that identifies the negotiated job title assigned to a specific person, rather than the normal title for that person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier of the job for which the job title override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top