Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Chapter → Show Chapter Details.

AI-generated

Summary

Retrieve detailed information about a specific VOD chapter by its unique identifier, optionally controlling pagination and response shape.

Inputs

  • authentication — Select authentication method to use: OAuth2 or API Key.
  • path_chapter (required) — The unique identifier of the chapter to retrieve details for.
  • queryParameters — Optional query parameters including 'Return' to get the total count instead of details, 'Page' to specify the page number, and 'Per Page' to specify the number of items per page.
  • returnAll — Whether to return all results or limit the number of returned items.
  • limit — Sets the maximum number of items to return if returnAll is false; valid range is 1 to 500.
  • returnFullResponse — If true, returns the full API response including metadata instead of just the main data.

Output shape

a JSON object containing the detailed information of the specified chapter, or a total count if requested, with optional pagination metadata if enabled

If 'Return' query parameter is set to 'total', the output is a count instead of detailed chapter data. Pagination parameters apply only if supported by the API. 'returnFullResponse' controls whether the output includes full API response or just main data. Errors and authentication failures will be returned as workflow errors.

Examples

Example 1: Retrieve basic details of a chapter

Set 'path_chapter' to the chapter ID, use default authentication, and leave optional parameters unset.

Example 2: Retrieve only the total count of chapters matching criteria

Set 'Return' query parameter to 'total' to receive a count of matching chapters instead of details.

Links

Discussion