Jump to

• Request
• Response

Get all media assets

get

/hcmRestApi/resources/11.13.18.05/recruitingCEMediaAssets

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 a media asset by primary key.
    Finder Variables
  • findCEMediaAssets Finds all the media assets using various attributes.
    Finder Variables
    • assetUsage; string; Site number for searching media assets.
    • daysSinceCreated; integer; Search criteria to find media assets based on assets usage.
    • imageFilter; string; Orientation for a given media asset.
    • keyword; string; Keyword (name) of a given media asset.
    • limit; integer; Limit value on number of assets returned.
    • offset; integer; Page offset; integer; for searching media assets.
    • siteNumber; string; Context for searching media assets.
    • sortBy; string; Sorting method for ordering list of assets returned.
  • findImageMediaAssets Number of days for searching media assets.
    Finder Variables
    • assetUsage; string; Search criteria to find media assets based on assets usage.
    • context; string; Context for searching media assets.
    • daysSinceCreated; integer; Number of days for searching media assets.
    • imageFilter; string; Orientation for a given media asset.
    • keyword; string; Keyword (name) of a given media asset.
    • limit; integer; Limit value on number of assets returned.
    • offset; integer; Page offset; integer; for searching media assets.
    • siteNumber; string; Site number for searching media assets.
    • sortBy; string; Sorting method for ordering list of assets returned.
• 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:
  

  • Context; string; Context for a given media asset.
  • ImageFilter; string; Orientation for a given media asset.
  • Keyword; string; Keyword (name) of a given media asset.
  • Limit; integer; Limit value on number of assets returned.
  • Offset; integer; Page offset for searching media assets.
  • SortBy; string; Sorting method for ordering list of assets returned.
  • TotalMediaAssetsCount; integer; Total number of media assets matching the search criteria.
  • Usage; string; Usage of a media asset.
• 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

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

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCEMediaAssets-item-response

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

Type: object

Show Source

• Context: string
  Maximum Length: 255

  Context for a given media asset.
• ImageFilter: string
  Maximum Length: 255

  Orientation for a given media asset.
• Keyword: string
  Keyword (name) of a given media asset.
• Limit: integer
  Limit value on number of assets returned.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• mediaAssets: array Media Assets
  Title: Media Assets

  The media assets resource is the child of the recruiting media assets resource and captures the metadata for a given media asset.
• Offset: integer
  Page offset for searching media assets.
• SortBy: string
  Maximum Length: 255

  Sorting method for ordering list of assets returned.
• TotalMediaAssetsCount: integer
  Total number of media assets matching the search criteria.
• Usage: string
  Maximum Length: 255

  Usage of a media asset.

{
    "type":"object",
    "properties":{
        "Context":{
            "maxLength":255,
            "type":"string",
            "description":"Context for a given media asset.",
            "nullable":false,
            "x-queryable":true
        },
        "Usage":{
            "maxLength":255,
            "type":"string",
            "description":"Usage of a media asset.",
            "nullable":true,
            "x-queryable":true
        },
        "Keyword":{
            "type":"string",
            "description":"Keyword (name) of a given media asset.",
            "nullable":true,
            "x-queryable":true
        },
        "ImageFilter":{
            "maxLength":255,
            "type":"string",
            "description":"Orientation for a given media asset.",
            "nullable":true,
            "x-queryable":true
        },
        "mediaAssets":{
            "title":"Media Assets",
            "type":"array",
            "description":"The media assets resource is the child of the recruiting media assets resource and captures the metadata for a given media asset.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEMediaAssets-mediaAssets-item-response"
            }
        },
        "SortBy":{
            "maxLength":255,
            "type":"string",
            "description":"Sorting method for ordering list of assets returned.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalMediaAssetsCount":{
            "type":"integer",
            "description":"Total number of media assets matching the search criteria.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Limit":{
            "type":"integer",
            "description":"Limit value on number of assets returned.",
            "nullable":true,
            "x-queryable":true
        },
        "Offset":{
            "type":"integer",
            "description":"Page offset for searching media assets.",
            "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 : Media Assets

Type: array

Title: Media Assets

The media assets resource is the child of the recruiting media assets resource and captures the metadata for a given media asset.

Show Source

• Array of: object recruitingCEMediaAssets-mediaAssets-item-response

{
    "title":"Media Assets",
    "type":"array",
    "description":"The media assets resource is the child of the recruiting media assets resource and captures the metadata for a given media asset.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEMediaAssets-mediaAssets-item-response"
    }
}

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."
        }
    }
}

Nested Schema : recruitingCEMediaAssets-mediaAssets-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MediaAssetGUID: string
  Read Only: true

  Maximum Length: 64

  Unique ID for a media asset.
• MediaAssetId: integer (int64)
  Read Only: true

  Primary key (media asset ID) for a media asset.
• MediaAssetName: string
  Read Only: true

  Maximum Length: 240

  Name of a media asset.
• mediaAssetProperties: array Media Asset Properties
  Title: Media Asset Properties

  The media asset properties resource is the child of the recruiting media asset details resource and retrieves details of a given media asset with properties.
• MediaAssetURL: string
  Read Only: true

  Maximum Length: 255

  URL of a media asset.
• MediaThumbnail: string
  Read Only: true

  Maximum Length: 255

  Thumbnail of a media asset.

{
    "type":"object",
    "properties":{
        "MediaAssetId":{
            "type":"integer",
            "description":"Primary key (media asset ID) for a media asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MediaThumbnail":{
            "maxLength":255,
            "type":"string",
            "description":"Thumbnail of a media asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaAssetName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of a media asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "mediaAssetProperties":{
            "title":"Media Asset Properties",
            "type":"array",
            "description":"The media asset properties resource is the child of the recruiting media asset details resource and retrieves details of a given media asset with properties.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEMediaAssets-mediaAssets-mediaAssetProperties-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MediaAssetGUID":{
            "maxLength":64,
            "type":"string",
            "description":"Unique ID for a media asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaAssetURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL of a media asset.",
            "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 : Media Asset Properties

Type: array

Title: Media Asset Properties

The media asset properties resource is the child of the recruiting media asset details resource and retrieves details of a given media asset with properties.

Show Source

• Array of: object recruitingCEMediaAssets-mediaAssets-mediaAssetProperties-item-response

{
    "title":"Media Asset Properties",
    "type":"array",
    "description":"The media asset properties resource is the child of the recruiting media asset details resource and retrieves details of a given media asset with properties.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEMediaAssets-mediaAssets-mediaAssetProperties-item-response"
    }
}

Nested Schema : recruitingCEMediaAssets-mediaAssets-mediaAssetProperties-item-response

Type: object

Show Source

• AssetPropertyKey: string
  Read Only: true

  Maximum Length: 20

  Attribute name of a media asset.
• AssetPropertyValue: string
  Read Only: true

  Maximum Length: 20

  Attribute value of a media asset.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssetPropertyValue":{
            "maxLength":20,
            "type":"string",
            "description":"Attribute value of a media asset.",
            "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"
            }
        },
        "AssetPropertyKey":{
            "maxLength":20,
            "type":"string",
            "description":"Attribute name of a media asset.",
            "nullable":false,
            "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"
    }
}

Back to Top