Jump to

• Request
• Response

Get all content items

get

/hcmRestApi/resources/11.13.18.05/contentItemsLov

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 all the content items that match the specified primary key criteria.
    Finder Variables
    • ContentItemId; integer; Unique identifier for the content item.
  • findBehForPersonCompetency Finds all the behavior content items to be added to the given person competency items following the precedence order position profile, job profile, organization profile, and item catalogs.
    Finder Variables
    • CompetencyItemId; integer; Unique identifier for the person competency item.
    • CompetencySectionId; integer; Unique identifier for the person competency section.
    • PersonId; integer; Unique identifier for the person.
  • findByContentItemId Finds all content item based on the specified content item ID.
    Finder Variables
    • ContentItemId; integer; Unique identifier for the content item.
  • findByContentValueSet Finds all content items that match the specified content item catalog criteria.
    Finder Variables
    • ContentTypeName; string; Name of the content type.
    • ContentValueSetCode; string; Unique code representing content item catalog.
  • findByRatingModelandContentType Finds all the content items that match the specified rating model and content type criteria.
    Finder Variables
    • ContentTypeId; integer; Unique identifier of the content type.
    • RatingModelId; integer; Unique identifier of the rating model.
  • findByWord Finds all content items that match the specified criteria.
    Finder Variables
    • ContentItemIdsNotIn; string; List of content item to exclude from the search response.
    • ContentTypeId; integer; Unique identifier of the content type.
    • ContentValueSetId; integer; Unique identifier of the content item catalog.
    • FilterAttributes; string; List of attributes for the search terms.
    • GoalTypeFlag; string; Indicate the type of the library goal.
    • SearchTerms; string; Search term criteria to retrieve data.
  • findGoalLibraryItems Finds all the content items that are related with the specified goal library content item.
    Finder Variables
    • ContentItemId; integer; Unique identifier for the goal library content item.
• 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:
  

  • ContentItemId; integer; Unique identifier for the content item.
  • ContentSectionId; integer; Unique identifier of the content section that matches the value set of the content item. The attribute ContentSectionId is valid only with the finder findGoalLibraryItems and for all other cases the attribute will remain null.
  • ContentTypeName; string; Name of the content item.
  • ContentValueSetCode; string; Unique code representing content item catalog.
  • ContentValueSetId; integer; Unique identifier of the content item catalog.
  • GoalBusinessUnitName; string; Business unit name for the library goal.
  • GoalCategory; string; Category of the library goal.
  • GoalDepartmentName; string; Department name for the library goal.
  • GoalJobFamilyName; string; Job family name for the library goal.
  • GoalLegalEntityName; string; Legal entity name for the library goal.
  • GoalSubType; string; Subtype of the library goal.
  • ItemDescription; string; Description for the content item.
  • Name; string; Name of the content item.
• 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(required):
  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(required):
  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 : contentItemsLov

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/contentItemsLov-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object contentItemsLov-item-response

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

Type: object

Show Source

• ContentItemId: integer (int64)
  Title: Content Item ID

  Read Only: true

  Unique identifier for the content item.
• ContentSectionId: integer
  Read Only: true

  Unique identifier of the content section that matches the value set of the content item. The attribute ContentSectionId is valid only with the finder findGoalLibraryItems and for all other cases the attribute will remain null.
• ContentTypeName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the content item.
• ContentValueSetCode: string
  Read Only: true

  Maximum Length: 30

  Unique code representing content item catalog.
• ContentValueSetId: integer (int64)
  Read Only: true

  Unique identifier of the content item catalog.
• GoalBusinessUnitName: string
  Read Only: true

  Maximum Length: 255

  Business unit name for the library goal.
• GoalCategory: string
  Read Only: true

  Maximum Length: 255

  Category of the library goal.
• GoalDepartmentName: string
  Read Only: true

  Maximum Length: 255

  Department name for the library goal.
• GoalJobFamilyName: string
  Read Only: true

  Maximum Length: 255

  Job family name for the library goal.
• GoalLegalEntityName: string
  Read Only: true

  Maximum Length: 255

  Legal entity name for the library goal.
• GoalSubType: string
  Read Only: true

  Maximum Length: 255

  Subtype of the library goal.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 2000

  Description for the content item.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 700

  Name of the content item.

{
    "type":"object",
    "properties":{
        "GoalBusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Business unit name for the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalDepartmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Department name for the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentTypeName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the content item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentValueSetId":{
            "type":"integer",
            "description":"Unique identifier of the content item catalog.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GoalSubType":{
            "maxLength":255,
            "type":"string",
            "description":"Subtype of the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description for the content item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GoalLegalEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Legal entity name for the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentValueSetCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code representing content item catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":700,
            "type":"string",
            "description":"Name of the content item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GoalCategory":{
            "maxLength":255,
            "type":"string",
            "description":"Category of the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the content item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GoalJobFamilyName":{
            "maxLength":255,
            "type":"string",
            "description":"Job family name for the library goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContentSectionId":{
            "type":"integer",
            "description":"Unique identifier of the content section that matches the value set of the content item. The attribute ContentSectionId is valid only with the finder findGoalLibraryItems and for all other cases the attribute will remain null.",
            "nullable":true,
            "readOnly":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