Jump to

• Request
• Response

Create a profile preference item for career preference section

post

/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/profilePreferences

Request

Path Parameters

• CareerPreferenceId(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=
• ProfileSectionId(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

• BusinessGroupId: integer (int64)
  Business group identifier of profile preference item in the career preference section.
• ContentTypeId: integer (int64)
  Content type identifier for the profile preference item in the career preference section.
• ObjectCode: string
  Maximum Length: 240

  Object code for the profile preference of career preference section.
• ObjectId: integer (int64)
  Object identifier for the profile preference of career preference section.
• ObjectType: string
  Maximum Length: 240

  Type of preference object in the career preference section.
• ObjectVersionNumber: integer (int32)
  Object version number for the preference item in the career preference section.
• ParentPreferenceId: integer (int64)
  Parent preference of the current preference item in the career preference section.
• ProfileId: integer (int64)
  Profile identifier of the user to whom the profile preference in the career preference section is assigned.
• ProfileItemId: integer (int64)
  Profile item identifier of the user to whom the profile preference for career preference section is assigned.
• ProfilePreferenceId: integer (int64)
  Unique identifier for the profile preference of career preference section.
• SectionId: integer (int64)
  Section to which the profile preference items in the career preference section are linked.

{
    "type":"object",
    "properties":{
        "BusinessGroupId":{
            "type":"integer",
            "description":"Business group identifier of profile preference item in the career preference section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContentTypeId":{
            "type":"integer",
            "description":"Content type identifier for the profile preference item in the career preference section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectCode":{
            "maxLength":240,
            "type":"string",
            "description":"Object code for the profile preference of career preference section.",
            "nullable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object identifier for the profile preference of career preference section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectType":{
            "maxLength":240,
            "type":"string",
            "description":"Type of preference object in the career preference section.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number for the preference item in the career preference section.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ParentPreferenceId":{
            "type":"integer",
            "description":"Parent preference of the current preference item in the career preference section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProfileId":{
            "type":"integer",
            "description":"Profile identifier of the user to whom the profile preference in the career preference section is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProfileItemId":{
            "type":"integer",
            "description":"Profile item identifier of the user to whom the profile preference for career preference section is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProfilePreferenceId":{
            "type":"integer",
            "description":"Unique identifier for the profile preference of career preference section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SectionId":{
            "type":"integer",
            "description":"Section to which the profile preference items in the career preference section are linked.",
            "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 : talentPersonProfiles-careerPreferenceSections-careerPreferenceItems-profilePreferences-item-response

Type: object

Show Source

• BusinessGroupId: integer (int64)
  Business group identifier of profile preference item in the career preference section.
• ContentTypeId: integer (int64)
  Content type identifier for the profile preference item in the career preference section.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the profile preference item in the career preference section.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the profile preference item in the career preference section was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the profile preference item in the career preference section was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the profile preference in the career preference section.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of the user who last updated the profile preference item in the career preference section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Maximum Length: 240

  Object code for the profile preference of career preference section.
• ObjectId: integer (int64)
  Object identifier for the profile preference of career preference section.
• ObjectType: string
  Maximum Length: 240

  Type of preference object in the career preference section.
• ObjectVersionNumber: integer (int32)
  Object version number for the preference item in the career preference section.
• ParentPreferenceId: integer (int64)
  Parent preference of the current preference item in the career preference section.
• ProfileId: integer (int64)
  Profile identifier of the user to whom the profile preference in the career preference section is assigned.
• ProfileItemId: integer (int64)
  Profile item identifier of the user to whom the profile preference for career preference section is assigned.
• ProfilePreferenceId: integer (int64)
  Unique identifier for the profile preference of career preference section.
• SectionId: integer (int64)
  Section to which the profile preference items in the career preference section are linked.

{
    "type":"object",
    "properties":{
        "BusinessGroupId":{
            "type":"integer",
            "description":"Business group identifier of profile preference item in the career preference section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContentTypeId":{
            "type":"integer",
            "description":"Content type identifier for the profile preference item in the career preference section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the profile preference item in the career preference section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the profile preference item in the career preference section was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the profile preference item in the career preference section was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the user who last updated the profile preference item in the career preference section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the profile preference in the career preference section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":240,
            "type":"string",
            "description":"Object code for the profile preference of career preference section.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object identifier for the profile preference of career preference section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":240,
            "type":"string",
            "description":"Type of preference object in the career preference section.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number for the preference item in the career preference section.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParentPreferenceId":{
            "type":"integer",
            "description":"Parent preference of the current preference item in the career preference section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"Profile identifier of the user to whom the profile preference in the career preference section is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileItemId":{
            "type":"integer",
            "description":"Profile item identifier of the user to whom the profile preference for career preference section is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfilePreferenceId":{
            "type":"integer",
            "description":"Unique identifier for the profile preference of career preference section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section to which the profile preference items in the career preference section are linked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Back to Top