Jump to

• Request
• Response

Create an area of study section

post

/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections

Request

Path Parameters

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

• areaOfStudyItems: array Area of Study Items
  Title: Area of Study Items

  The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.
• ProfileSectionId: integer (int64)
  Title: Profile Section ID

  Unique identifier of the area of study section associated with the profile.
• SectionContext: string
  Title: Section Context

  Maximum Length: 300

  Code of the area of study section. Valid values are defined in the profileTypeSectionsLOV.
• SectionId(required): integer (int64)
  Title: Section ID

  Unique identifier of the area of study section.

{
    "required":[
        "SectionId"
    ],
    "type":"object",
    "properties":{
        "SectionContext":{
            "title":"Section Context",
            "maxLength":"300",
            "type":"string",
            "description":"Code of the area of study section. Valid values are defined in the profileTypeSectionsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "areaOfStudyItems":{
            "title":"Area of Study Items",
            "type":"array",
            "description":"The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.",
            "items":{
                "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-post-request"
            }
        },
        "SectionId":{
            "title":"Section ID",
            "type":"integer",
            "description":"Unique identifier of the area of study section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProfileSectionId":{
            "title":"Profile Section ID",
            "type":"integer",
            "description":"Unique identifier of the area of study section associated with the profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Area of Study Items

Type: array

Title: Area of Study Items

The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.

Show Source

• Array of: object talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-post-request

{
    "title":"Area of Study Items",
    "type":"array",
    "description":"The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.",
    "items":{
        "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-post-request"
    }
}

Nested Schema : talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-post-request

Type: object

Show Source

• AreaOfStudy: string
  Title: Area of Study

  Maximum Length: 240

  Area of Study of a person.
• AreaOfStudyId: integer (int64)
  Surrogate identifier for the person area of study.
• areaOfStudyItemsDFF: array areaOfStudyItemsDFF
• AverageGrade: string
  Title: Grade

  Maximum Length: 240

  Average grade achieved for the area of study item.
• DateAcquired: string (date)
  Title: Date Acquired

  Date on which the area of study item was acquired.
• ProfileId(required): integer (int64)
  Unique identifier of the person profile.
• SectionId: integer (int64)
  Unique identifier of the profile content section.

{
    "required":[
        "ProfileId"
    ],
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Unique identifier of the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DateAcquired":{
            "title":"Date Acquired",
            "type":"string",
            "description":"Date on which the area of study item was acquired.",
            "format":"date",
            "nullable":true
        },
        "AverageGrade":{
            "title":"Grade",
            "maxLength":"240",
            "type":"string",
            "description":"Average grade achieved for the area of study item.",
            "nullable":true
        },
        "areaOfStudyItemsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "AreaOfStudyId":{
            "type":"integer",
            "description":"Surrogate identifier for the person area of study.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SectionId":{
            "type":"integer",
            "description":"Unique identifier of the profile content section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AreaOfStudy":{
            "title":"Area of Study",
            "maxLength":"240",
            "type":"string",
            "description":"Area of Study of a person.",
            "nullable":true
        }
    }
}

Nested Schema : areaOfStudyItemsDFF

Type: array

Show Source

• Array of: object talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 80

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• AreaOfStudyId: integer (int64)

{
    "type":"object",
    "properties":{
        "AreaOfStudyId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"80",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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-areaOfStudySections-item-response

Type: object

Show Source

• areaOfStudyItems: array Area of Study Items
  Title: Area of Study Items

  The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the area of study section.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the area of study section was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the area of study section was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the area of study section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProfileSectionId: integer (int64)
  Title: Profile Section ID

  Unique identifier of the area of study section associated with the profile.
• SectionContext: string
  Title: Section Context

  Maximum Length: 300

  Code of the area of study section. Valid values are defined in the profileTypeSectionsLOV.
• SectionId: integer (int64)
  Title: Section ID

  Unique identifier of the area of study section.
• SectionName: string
  Title: Section Name

  Read Only: true

  Maximum Length: 240

  Name of the section. Valid values are defined in the profileTypeSectionsLOV.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the area of study section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionContext":{
            "title":"Section Context",
            "maxLength":"300",
            "type":"string",
            "description":"Code of the area of study section. Valid values are defined in the profileTypeSectionsLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the area of study section was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the area of study section.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SectionName":{
            "title":"Section Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the section. Valid values are defined in the profileTypeSectionsLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "areaOfStudyItems":{
            "title":"Area of Study Items",
            "type":"array",
            "description":"The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.",
            "items":{
                "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-response"
            }
        },
        "SectionId":{
            "title":"Section ID",
            "type":"integer",
            "description":"Unique identifier of the area of study section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProfileSectionId":{
            "title":"Profile Section ID",
            "type":"integer",
            "description":"Unique identifier of the area of study section associated with the profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the area of study section was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Area of Study Items

Type: array

Title: Area of Study Items

The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.

Show Source

• Array of: object talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-response

{
    "title":"Area of Study Items",
    "type":"array",
    "description":"The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.",
    "items":{
        "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-response"
    }
}

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

Type: object

Show Source

• AreaOfStudy: string
  Title: Area of Study

  Maximum Length: 240

  Area of Study of a person.
• AreaOfStudyId: integer (int64)
  Surrogate identifier for the person area of study.
• areaOfStudyItemsDFF: array areaOfStudyItemsDFF
• AverageGrade: string
  Title: Grade

  Maximum Length: 240

  Average grade achieved for the area of study item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the area of study item.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the area of study item was created.
• DateAcquired: string (date)
  Title: Date Acquired

  Date on which the area of study item was acquired.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the area of study item was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the area of study item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProfileId: integer (int64)
  Unique identifier of the person profile.
• SectionId: integer (int64)
  Unique identifier of the profile content section.
• Source: string
  Title: Source

  Read Only: true

  Maximum Length: 255

  Default Value: Talent Profile

  Source of the areaOfStudy item.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the area of study item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"Unique identifier of the person profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the area of study item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the area of study item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "areaOfStudyItemsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Source":{
            "title":"Source",
            "maxLength":"255",
            "type":"string",
            "description":"Source of the areaOfStudy item.",
            "nullable":true,
            "readOnly":true,
            "default":"Talent Profile",
            "x-queryable":true
        },
        "DateAcquired":{
            "title":"Date Acquired",
            "type":"string",
            "description":"Date on which the area of study item was acquired.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AverageGrade":{
            "title":"Grade",
            "maxLength":"240",
            "type":"string",
            "description":"Average grade achieved for the area of study item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AreaOfStudyId":{
            "type":"integer",
            "description":"Surrogate identifier for the person area of study.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Unique identifier of the profile content section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the area of study item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AreaOfStudy":{
            "title":"Area of Study",
            "maxLength":"240",
            "type":"string",
            "description":"Area of Study of a person.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : areaOfStudyItemsDFF

Type: array

Show Source

• Array of: object talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 80

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• AreaOfStudyId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AreaOfStudyId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"80",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Links

areaOfStudyItems

Operation: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems

Parameters:

• ProfileSectionId2: $request.path.ProfileSectionId2
• talentPersonProfilesUniqID: $request.path.talentPersonProfilesUniqID

The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.

sectionContextLOV

Operation: /hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: SectionContext; Target Attribute: SectionContext
• Display Attribute: SectionContext, Name

Back to Top