Jump to

• Request
• Response

Update a job attribute

patch

/fscmRestApi/resources/11.13.18.05/publicSectorEmployees/{PersonId}/child/PersonJobFunctions/{PersonJobFunctionsUniqID}/child/PersonJobFuncAssignments/{PersonJobFuncAssignmentsUniqID}

Request

Path Parameters

• PersonId(required): integer(int64)
  The identifier of the person for whom the record is created.
• PersonJobFuncAssignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PersJobFuncAssignId, PersonId, PersJobFuncId, JobFuncId and JobFuncSecId ---for the Person Job Attributes resource and used to uniquely identify an instance of Person Job Attributes. The client should not generate the hash key value. Instead, the client should query on the Person Job Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Person Job Attributes.
  
  For example: PersonJobFuncAssignments?q=PersJobFuncAssignId=<value1>;PersonId=<value2>;PersJobFuncId=<value3>;JobFuncId=<value4>;JobFuncSecId=<value5>
• PersonJobFunctionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PersJobFuncId, PersonId and JobFuncId ---for the Person Job Functions resource and used to uniquely identify an instance of Person Job Functions. The client should not generate the hash key value. Instead, the client should query on the Person Job Functions collection resource with a filter on the primary key values in order to navigate to a specific instance of Person Job Functions.
  
  For example: PersonJobFunctions?q=PersJobFuncId=<value1>;PersonId=<value2>;JobFuncId=<value3>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job attribute is available for the employee to use.
• JobFuncSecId: string
  Title: Job Attribute

  Maximum Length: 50

  A unique identifier of the job attribute.
• JobFuncSectnValue: string
  Title: Attribute Value

  Maximum Length: 1000

  A unique value of the job attribute.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the job attribute is available for the employee to use.",
            "nullable":true
        },
        "JobFuncSecId":{
            "title":"Job Attribute",
            "maxLength":"50",
            "type":"string",
            "description":"A unique identifier of the job attribute.",
            "nullable":true
        },
        "JobFuncSectnValue":{
            "title":"Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"A unique value of the job attribute.",
            "nullable":true
        }
    }
}

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 : publicSectorEmployees-PersonJobFunctions-PersonJobFuncAssignments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  An identifier of the public sector agency.
• 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.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job attribute is available for the employee to use.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  A unique identifier of the job function.
• JobFuncSecId: string
  Title: Job Attribute

  Maximum Length: 50

  A unique identifier of the job attribute.
• JobFuncSectnValue: string
  Title: Attribute Value

  Maximum Length: 1000

  A unique value of the job attribute.
• 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.
• PersJobFuncAssignId: integer (int64)
  An identifier for the row assigned using an auto generated number.
• PersJobFuncId: integer (int64)
  An identifier for the unique row assigned using an auto generated number.
• PersonId: integer (int64)
  The name of the person for whom the row was created.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"An identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PersJobFuncId":{
            "type":"integer",
            "description":"An identifier for the unique row assigned using an auto generated number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersJobFuncAssignId":{
            "type":"integer",
            "description":"An identifier for the row assigned using an auto generated number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The name of the person for whom the row was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobFuncSecId":{
            "title":"Job Attribute",
            "maxLength":"50",
            "type":"string",
            "description":"A unique identifier of the job attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFuncId":{
            "title":"Job Function ID",
            "maxLength":"50",
            "type":"string",
            "description":"A unique identifier of the job function.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the job attribute is available for the employee to use.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFuncSectnValue":{
            "title":"Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"A unique value of the job attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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