Jump to

• Request
• Response

Update a career of interest

patch

/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}

Request

Path Parameters

• CareerInterestId(required): integer(int64)
  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=
• talentPersonProfilesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Talent Person Profiles resource and used to uniquely identify an instance of Talent Person Profiles. The client should not generate the hash key value. Instead, the client should query on the Talent Person Profiles collection resource in order to navigate to a specific instance of Talent Person Profiles to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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

• AssignedByPersonId: integer (int64)
  Title: Added By

  Unique identifier of the person who assigned the career of interest to the employee.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 30

  Default Value: false

  Indicates whether the career of interest is private or not.

{
    "type":"object",
    "properties":{
        "AssignedByPersonId":{
            "title":"Added By",
            "type":"integer",
            "description":"Unique identifier of the person who assigned the career of interest to the employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the career of interest is private or not.",
            "nullable":false,
            "default":false
        }
    }
}

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 : talentPersonProfiles-careersOfInterest-item-response

Type: object

Show Source

• AssignedByPersonId: integer (int64)
  Title: Added By

  Unique identifier of the person who assigned the career of interest to the employee.
• CareerInterestId: integer (int64)
  Unique identifier of the career of interest.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the career of interest.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the career of interest was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the career of interest was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the career of interest.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModelProfileCode: string
  Title: Profile Code

  Maximum Length: 30

  Code for the model profile ID.
• ModelProfileId: integer (int64)
  Title: Job

  Unique identifier of the model profile.
• ModelProfileName: string
  Title: Name

  Read Only: true

  Maximum Length: 4000

  Name of the model profile.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 30

  Default Value: false

  Indicates whether the career of interest is private or not.

{
    "type":"object",
    "properties":{
        "AssignedByPersonId":{
            "title":"Added By",
            "type":"integer",
            "description":"Unique identifier of the person who assigned the career of interest to the employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CareerInterestId":{
            "type":"integer",
            "description":"Unique identifier of the career of interest.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the career of interest.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the career of interest was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the career of interest was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the career of interest.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ModelProfileCode":{
            "title":"Profile Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the model profile ID.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ModelProfileId":{
            "title":"Job",
            "type":"integer",
            "description":"Unique identifier of the model profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ModelProfileName":{
            "title":"Name",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the model profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the career of interest is private or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

modelProfileCodesLOV

Operation: /hcmRestApi/resources/11.13.18.05/profilesLov

The following properties are defined on the LOV link relation:

• Source Attribute: ModelProfileCode; Target Attribute: ProfileCode
• Display Attribute: ProfileCode, ProfileId

Back to Top