Jump to

• Request
• Response

Update an education level item

patch

/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}

Request

Path Parameters

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

• AverageGrade: string
  Title: Average Grade

  Maximum Length: 240

  Average grade achieved for the education level item.
• AwardingBody: string
  Title: Awarding Body

  Maximum Length: 240

  Awarding body for the education level.
• Comments: string (byte)
  Title: Comments

  Comments on the education level.
• Country: string
  Title: Country Code

  Maximum Length: 30

  Country where education level is received. Valid values are defined in the HcmCountriesLOV.
• EducationalEstablishmentId: integer (int64)
  Title: School

  Name of the educational establishment. Valid values are defined in the contentItemsLOV.
• EducationLevel: string
  Title: Education Level

  Education level of a person.
• EducationLevelCompleted: string
  Title: Completed

  Maximum Length: 30

  Indicates whether the education level is completed. Valid values are Y and N. Valid values are defined in the commonLookupsLOV.
• educationLvlItemsDFF: array educationLvlItemsDFF
• Establishment: string
  Title: School

  Name of the educational establishment.
• OtherEstablishment: string
  Title: School Name

  Maximum Length: 2000

  Name of the other educational establishment.
• ProjectedCompletionDate: string (date)
  Title: Projected Completion Date

  Date on which the education level item is projected to be complete.
• State: string
  Title: State Code

  Maximum Length: 360

  State of the education level item.
• Title: string
  Title: Title

  Maximum Length: 240

  Title of the education level.

{
    "type":"object",
    "properties":{
        "EducationLevelCompleted":{
            "title":"Completed",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the education level is completed. Valid values are Y and N. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the education level.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the education level.",
            "nullable":true
        },
        "Establishment":{
            "title":"School",
            "type":"string",
            "description":"Name of the educational establishment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EducationLevel":{
            "title":"Education Level",
            "type":"string",
            "description":"Education level of a person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProjectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"Date on which the education level item is projected to be complete.",
            "format":"date",
            "nullable":true
        },
        "State":{
            "title":"State Code",
            "maxLength":360,
            "type":"string",
            "description":"State of the education level item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "educationLvlItemsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "OtherEstablishment":{
            "title":"School Name",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the other educational establishment.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishmentId":{
            "title":"School",
            "type":"integer",
            "description":"Name of the educational establishment. Valid values are defined in the contentItemsLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Country":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"Country where education level is received. Valid values are defined in the HcmCountriesLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AverageGrade":{
            "title":"Average Grade",
            "maxLength":240,
            "type":"string",
            "description":"Average grade achieved for the education level item.",
            "nullable":true
        },
        "AwardingBody":{
            "title":"Awarding Body",
            "maxLength":240,
            "type":"string",
            "description":"Awarding body for the education level.",
            "nullable":true
        }
    }
}

Nested Schema : educationLvlItemsDFF

Type: array

Show Source

• Array of: object talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-patch-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

{
    "type":"object",
    "properties":{
        "__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-educationLvlSections-educationLvlItems-item-response

Type: object

Show Source

• AverageGrade: string
  Title: Average Grade

  Maximum Length: 240

  Average grade achieved for the education level item.
• AwardingBody: string
  Title: Awarding Body

  Maximum Length: 240

  Awarding body for the education level.
• Comments: string (byte)
  Title: Comments

  Comments on the education level.
• ContentItemId: integer (int64)
  Title: Education Level

  Unique identifier for the content item.
• Country: string
  Title: Country Code

  Maximum Length: 30

  Country where education level is received. Valid values are defined in the HcmCountriesLOV.
• CountryMeaning: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 80

  Country of the education level items.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the content item was created.
• EducationalEstablishmentId: integer (int64)
  Title: School

  Name of the educational establishment. Valid values are defined in the contentItemsLOV.
• EducationLevel: string
  Title: Education Level

  Education level of a person.
• EducationLevelCompleted: string
  Title: Completed

  Maximum Length: 30

  Indicates whether the education level is completed. Valid values are Y and N. Valid values are defined in the commonLookupsLOV.
• EducationLevelId: integer (int64)
  Surrogate identifier for the person education level.
• educationLvlItemsDFF: array educationLvlItemsDFF
• Establishment: string
  Title: School

  Name of the educational establishment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Maximum Length: 64

  User who last updated the content item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OtherEstablishment: string
  Title: School Name

  Maximum Length: 2000

  Name of the other educational establishment.
• ProfileId: integer (int64)
  Unique identifier of the person profile.
• ProjectedCompletionDate: string (date)
  Title: Projected Completion Date

  Date on which the education level item is projected to be complete.
• 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 educationLevel item.
• State: string
  Title: State Code

  Maximum Length: 360

  State of the education level item.
• Title: string
  Title: Title

  Maximum Length: 240

  Title of the education level.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the content 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 content item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the content item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryMeaning":{
            "title":"Territory Name",
            "maxLength":80,
            "type":"string",
            "description":"Country of the education level items.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EducationLevelCompleted":{
            "title":"Completed",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the education level is completed. Valid values are Y and N. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the education level.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the education level.",
            "nullable":true,
            "x-queryable":true
        },
        "Establishment":{
            "title":"School",
            "type":"string",
            "description":"Name of the educational establishment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EducationLevel":{
            "title":"Education Level",
            "type":"string",
            "description":"Education level of a person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Source":{
            "title":"Source",
            "maxLength":255,
            "type":"string",
            "description":"Source of the educationLevel item.",
            "nullable":true,
            "readOnly":true,
            "default":"Talent Profile",
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Education Level",
            "type":"integer",
            "description":"Unique identifier for the content item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"Date on which the education level item is projected to be complete.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State Code",
            "maxLength":360,
            "type":"string",
            "description":"State of the education level item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "educationLvlItemsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "OtherEstablishment":{
            "title":"School Name",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the other educational establishment.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishmentId":{
            "title":"School",
            "type":"integer",
            "description":"Name of the educational establishment. Valid values are defined in the contentItemsLOV.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"Country where education level is received. Valid values are defined in the HcmCountriesLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AverageGrade":{
            "title":"Average Grade",
            "maxLength":240,
            "type":"string",
            "description":"Average grade achieved for the education level 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"
            }
        },
        "EducationLevelId":{
            "type":"integer",
            "description":"Surrogate identifier for the person education level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AwardingBody":{
            "title":"Awarding Body",
            "maxLength":240,
            "type":"string",
            "description":"Awarding body for the education level.",
            "nullable":true,
            "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 content item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : educationLvlItemsDFF

Type: array

Show Source

• Array of: object talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-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-educationLvlSections-educationLvlItems-educationLvlItemsDFF-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
• EducationLevelId: 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"
            }
        },
        "EducationLevelId":{
            "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

countriesLOV

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryCode
• Display Attribute: CountryName

eduLevelsLOV

Operation: /hcmRestApi/resources/11.13.18.05/contentItemsLov

Parameters:

• finder: findByWord%3BContentValueSetId%3D{ContentValueSetId}%2CContentTypeId%3D107

The following properties are defined on the LOV link relation:

• Source Attribute: EducationLevel; Target Attribute: Name
• Display Attribute: ContentValueSetCode, Name

educationLevelCompletedLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder

The following properties are defined on the LOV link relation:

• Source Attribute: EducationLevelCompleted; Target Attribute: LookupCode
• Display Attribute: LookupCode, Meaning

educationLvlItemsDFF

Operation: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/child/educationLvlItemsDFF

Parameters:

• EducationLevelId: $request.path.EducationLevelId
• ProfileSectionId6: $request.path.ProfileSectionId6
• talentPersonProfilesUniqID: $request.path.talentPersonProfilesUniqID

establishmentsLOV

Operation: /hcmRestApi/resources/11.13.18.05/contentItemsLov

The following properties are defined on the LOV link relation:

• Source Attribute: Establishment; Target Attribute: Name
• Display Attribute: Name

Back to Top