Jump to

• Request
• Response

Get all the education items of the candidate.

get

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the education items by a primary key
    Finder Variables
    • EducationId; integer; Finds the education items by using the variable education ID
  • findBySectionId Finds the education items by using the findBysectionID
    Finder Variables
    • FlowVersionId; integer; Finds the education items by using the findBysectionID and the FlowVersionId; integer;
    • SectionId; integer; Finds the education items by using the findBysectionID and SectionId; integer;
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicStanding; string; Performance of the candidate in education
  • AreaOfStudy; string; Area of study done by the candidate.
  • AverageGrade; string; Average grade secured in education by the candidate.
  • AwardingBody; string; Authority granting recognition in the field of education to the candidate.
  • City; string; City in which the education was done.
  • CompletedAmount; integer; Completed Amount in candidate education items.
  • CompletedTraningUnits; string; Completed Training Units in candidate education items.
  • ContentItemId; integer; Unique identifier assigned to the content.
  • CountryCode; string; Country Code of the location of education.
  • CountryId; integer; ID assigned to the country where the education was done.
  • DateAcquired; string; Date when the degree was acquired.
  • DegreeName; string; Name of the education degree earned by the candidate.
  • Department; string; Department in which the education is acquired.
  • Duration; string; Duration of the education.
  • DurationUnits; string; Unit of the duration of education.
  • EduLevelCompletedFlag; boolean; Indicates if the education is complete.
  • EducationId; integer; ID assigned to the education item.
  • EducationLevel; string; Level of the education.
  • EducationURL; string; URL of the education.
  • EducationalEstablishment; string; Name of the education establishment.
  • EducationalEstablishmentId; integer; ID assigned to the education establishment.
  • Educator; string; Educator of the education item.
  • EndDate; string; End date of the education item.
  • Fee; integer; Fees of the education item.
  • FeeCurrency; string; Currency in which the education fees has been paid.
  • GPA; number; GPA score of the candidate.
  • GraduatedFlag; boolean; Indicates if the candidate is a graduate.
  • HighestEduLevel; string; Highest educational level availed by the candidate.
  • Major; string; Major subjects in the education availed by the candidate.
  • Minor; string; Minor subjects in education availed by the candidate.
  • PartTimeFlag; boolean; Indicates if the education item is part time or not.
  • ProjectedCompletionDate; string; Projected completion date of the education item.
  • RequiredFlag; boolean; Indicates if the education item is required or not.
  • SectionId; integer; Section ID assigned to the education item.
  • StartDate; string; Start date of the education item.
  • StateProvinceCode; string; Code assigned to the State Province where the education took place.
  • StateProvinceId; integer; Unique identifier assigned to the State Province where the education took place.
  • Status; string; Status of the education.
  • SubmissionId; integer; Submission ID generated against the educational details entered by the candidate.
  • Title; string; Title of the education item
  • TotalAmount; integer; Total amount of the education item
  • TrmnlDegDiscpFlag; boolean; Indicates if the education item is a terminal degree
  • TuitionMethod; string; Mode of tuition availed during the course of education.
  • YearAcquired; integer; Year in which the education was completed.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingCECandidateEducationItems-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCECandidateEducationItems-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingCECandidateEducationItems-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 : recruitingCECandidateEducationItems-item-response

Type: object

Show Source

• AcademicStanding: string
  Title: Academic Standing

  Maximum Length: 30

  Performance of the candidate in education
• ActivitySummary: string (byte)
  Title: Summary of Activities

  Activity Summary in candidate education items.
• AreaOfStudy: string
  Title: Area of Study

  Maximum Length: 240

  Area of study done by the candidate.
• AverageGrade: string
  Title: Average Grade

  Maximum Length: 240

  Average grade secured in education by the candidate.
• AwardingBody: string
  Title: Awarding Body

  Maximum Length: 240

  Authority granting recognition in the field of education to the candidate.
• City: string
  Title: City

  Maximum Length: 240

  City in which the education was done.
• Comments: string (byte)
  Title: Comments

  Comments on the candidate education details.
• CompletedAmount: integer (int64)
  Title: Completed Amount

  Completed Amount in candidate education items.
• CompletedTraningUnits: string
  Title: Training Completed Units

  Maximum Length: 240

  Completed Training Units in candidate education items.
• ContentItemId: integer (int64)
  Title: Degree

  Unique identifier assigned to the content.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  Country Code of the location of education.
• CountryId: integer (int64)
  Title: Country

  ID assigned to the country where the education was done.
• DateAcquired: string (date)
  Title: Date Acquired

  Date when the degree was acquired.
• DegreeName: string
  Title: Degree

  Maximum Length: 240

  Name of the education degree earned by the candidate.
• Department: string
  Title: Faculty or Department

  Maximum Length: 240

  Department in which the education is acquired.
• Description: string (byte)
  Title: Description

  Description of the education item.
• Duration: string
  Title: Duration

  Maximum Length: 240

  Duration of the education.
• DurationUnits: string
  Title: Duration Units

  Maximum Length: 30

  Unit of the duration of education.
• EducationalEstablishment: string
  Title: School Name

  Maximum Length: 2000

  Name of the education establishment.
• EducationalEstablishmentId: integer (int64)
  Title: School

  ID assigned to the education establishment.
• EducationId: integer (int64)
  ID assigned to the education item.
• EducationLevel: string
  Title: Education Level

  Maximum Length: 30

  Level of the education.
• EducationURL: string
  Title: Education URL

  Maximum Length: 2000

  URL of the education.
• Educator: string
  Title: Educator

  Maximum Length: 240

  Educator of the education item.
• EduLevelCompletedFlag: boolean
  Title: Education Level Completed

  Maximum Length: 30

  Indicates if the education is complete.
• EndDate: string (date)
  Title: End Date

  End date of the education item.
• Fee: integer (int64)
  Title: Fee

  Fees of the education item.
• FeeCurrency: string
  Title: Fee Currency

  Maximum Length: 30

  Currency in which the education fees has been paid.
• FlowVersionId: integer
  This gives service metadata information
• GPA: number
  Title: GPA

  GPA score of the candidate.
• GraduatedFlag: boolean
  Title: Graduated

  Maximum Length: 30

  Indicates if the candidate is a graduate.
• HighestEduLevel: string
  Title: Highest Education Level

  Maximum Length: 30

  Highest educational level availed by the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Major: string
  Title: Major

  Maximum Length: 240

  Major subjects in the education availed by the candidate.
• Minor: string
  Title: Minor

  Maximum Length: 240

  Minor subjects in education availed by the candidate.
• PartTimeFlag: boolean
  Title: Part Time

  Maximum Length: 30

  Indicates if the education item is part time or not.
• ProjectedCompletionDate: string (date)
  Title: Projected Completion Date

  Projected completion date of the education item.
• Reimbursements: string (byte)
  Title: Reimbursement Arrangements

  Reimbursements that can be availed against an education item.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 30

  Indicates if the education item is required or not.
• SectionId: integer (int64)
  Section ID assigned to the education item.
• StartDate: string (date)
  Title: Start Date

  Start date of the education item.
• StateProvinceCode: string
  Title: State

  Maximum Length: 360

  Code assigned to the State Province where the education took place.
• StateProvinceId: integer (int64)
  Title: State

  Unique identifier assigned to the State Province where the education took place.
• Status: string
  Title: Status

  Maximum Length: 30

  Status of the education.
• SubmissionId: integer
  Submission ID generated against the educational details entered by the candidate.
• Title: string
  Title: Title

  Maximum Length: 240

  Title of the education item
• TotalAmount: integer (int64)
  Title: Total Amount

  Total amount of the education item
• TrmnlDegDiscpFlag: boolean
  Title: Terminal Degree for Discipline

  Maximum Length: 30

  Indicates if the education item is a terminal degree
• TuitionMethod: string
  Title: Tuition Method

  Maximum Length: 30

  Mode of tuition availed during the course of education.
• YearAcquired: integer (int64)
  Title: Year Acquired

  Year in which the education was completed.

{
    "type":"object",
    "properties":{
        "Educator":{
            "title":"Educator",
            "maxLength":240,
            "type":"string",
            "description":"Educator of the education item.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedTraningUnits":{
            "title":"Training Completed Units",
            "maxLength":240,
            "type":"string",
            "description":"Completed Training Units in candidate education items.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the education item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Department":{
            "title":"Faculty or Department",
            "maxLength":240,
            "type":"string",
            "description":"Department in which the education is acquired.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Completed Amount in candidate education items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrmnlDegDiscpFlag":{
            "title":"Terminal Degree for Discipline",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the education item is a terminal degree",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EducationId":{
            "type":"integer",
            "description":"ID assigned to the education item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CountryId":{
            "title":"Country",
            "type":"integer",
            "description":"ID assigned to the country where the education was done.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the education.",
            "nullable":true,
            "x-queryable":true
        },
        "StateProvinceId":{
            "title":"State",
            "type":"integer",
            "description":"Unique identifier assigned to the State Province where the education took place.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EducationURL":{
            "title":"Education URL",
            "maxLength":2000,
            "type":"string",
            "description":"URL of the education.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "maxLength":240,
            "type":"string",
            "description":"Duration of the education.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":240,
            "type":"string",
            "description":"City in which the education was done.",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicStanding":{
            "title":"Academic Standing",
            "maxLength":30,
            "type":"string",
            "description":"Performance of the candidate in education",
            "nullable":true,
            "x-queryable":true
        },
        "EduLevelCompletedFlag":{
            "title":"Education Level Completed",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the education is complete.",
            "nullable":true,
            "x-queryable":true
        },
        "AverageGrade":{
            "title":"Average Grade",
            "maxLength":240,
            "type":"string",
            "description":"Average grade secured in education by the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "DegreeName":{
            "title":"Degree",
            "maxLength":240,
            "type":"string",
            "description":"Name of the education degree earned by the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID assigned to the education item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "YearAcquired":{
            "title":"Year Acquired",
            "type":"integer",
            "description":"Year in which the education was completed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AreaOfStudy":{
            "title":"Area of Study",
            "maxLength":240,
            "type":"string",
            "description":"Area of study done by the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeCurrency":{
            "title":"Fee Currency",
            "maxLength":30,
            "type":"string",
            "description":"Currency in which the education fees has been paid.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the education item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Reimbursements":{
            "title":"Reimbursement Arrangements",
            "type":"string",
            "description":"Reimbursements that can be availed against an education item.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"This gives service metadata information",
            "nullable":true,
            "x-queryable":false
        },
        "ActivitySummary":{
            "title":"Summary of Activities",
            "type":"string",
            "description":"Activity Summary in candidate education items.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "title":"Degree",
            "type":"integer",
            "description":"Unique identifier assigned to the content.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GraduatedFlag":{
            "title":"Graduated",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the candidate is a graduate.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardingBody":{
            "title":"Awarding Body",
            "maxLength":240,
            "type":"string",
            "description":"Authority granting recognition in the field of education to the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Country Code of the location of education.",
            "nullable":true,
            "x-queryable":true
        },
        "HighestEduLevel":{
            "title":"Highest Education Level",
            "maxLength":30,
            "type":"string",
            "description":"Highest educational level availed by the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments on the candidate education details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Fee":{
            "title":"Fee",
            "type":"integer",
            "description":"Fees of the education item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartTimeFlag":{
            "title":"Part Time",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the education item is part time or not.",
            "nullable":true,
            "x-queryable":true
        },
        "StateProvinceCode":{
            "title":"State",
            "maxLength":360,
            "type":"string",
            "description":"Code assigned to the State Province where the education took place.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the education item",
            "nullable":true,
            "x-queryable":true
        },
        "DurationUnits":{
            "title":"Duration Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of the duration of education.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount of the education item",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EducationLevel":{
            "title":"Education Level",
            "maxLength":30,
            "type":"string",
            "description":"Level of the education.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the education item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TuitionMethod":{
            "title":"Tuition Method",
            "maxLength":30,
            "type":"string",
            "description":"Mode of tuition availed during the course of education.",
            "nullable":true,
            "x-queryable":true
        },
        "Major":{
            "title":"Major",
            "maxLength":240,
            "type":"string",
            "description":"Major subjects in the education availed by the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "DateAcquired":{
            "title":"Date Acquired",
            "type":"string",
            "description":"Date when the degree was acquired.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"Projected completion date of the education item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EducationalEstablishment":{
            "title":"School Name",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the education establishment.",
            "nullable":true,
            "x-queryable":true
        },
        "EducationalEstablishmentId":{
            "title":"School",
            "type":"integer",
            "description":"ID assigned to the education establishment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID generated against the educational details entered by the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "GPA":{
            "title":"GPA",
            "type":"number",
            "description":"GPA score of the candidate.",
            "nullable":true,
            "x-hints":{
                "precision":15,
                "scale":2
            },
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the education item is required or not.",
            "nullable":true,
            "x-queryable":true
        },
        "Minor":{
            "title":"Minor",
            "maxLength":240,
            "type":"string",
            "description":"Minor subjects in education availed by the candidate.",
            "nullable":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