Jump to

• Request
• Response

Update a job title

patch

/fscmRestApi/resources/11.13.18.05/publicSectorJobTitles/{publicSectorJobTitlesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorJobTitlesUniqID: integer
  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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorJobTitles-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  Identifier of the public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• JobTitleDescription(optional): string
  Title: Description

  Maximum Length: 100

  The description of the job title.
• JobTitleId(optional): string
  Title: Job Title

  Maximum Length: 50

  The unique identifier of the job title.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ValidFromDate(optional): string(date)
  Title: Valid From

  The date from which the job title is available for use.
• ValidToDate(optional): string(date)
  Title: Valid To

  The date until which the job title is available for use.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "JobTitleDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the job title.",
            "title":"Description"
        },
        "JobTitleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job title.",
            "title":"Job Title"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The date from which the job title is available for use.",
            "title":"Valid From"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The date until which the job title is available for use.",
            "title":"Valid To"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorJobTitles-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  Identifier of the public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• JobTitleDescription(optional): string
  Title: Description

  Maximum Length: 100

  The description of the job title.
• JobTitleId(optional): string
  Title: Job Title

  Maximum Length: 50

  The unique identifier of the job title.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ValidFromDate(optional): string(date)
  Title: Valid From

  The date from which the job title is available for use.
• ValidToDate(optional): string(date)
  Title: Valid To

  The date until which the job title is available for use.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"Identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "JobTitleDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the job title.",
            "title":"Description"
        },
        "JobTitleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job title.",
            "title":"Job Title"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The date from which the job title is available for use.",
            "title":"Valid From"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The date until which the job title is available for use.",
            "title":"Valid To"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top