Function: getChildCustomContent()

function getChildCustomContent(client, parameters): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  results?: object[];
}>;

Defined in: src/v2/api/children.ts:227

Returns all child custom content for given custom content id. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only custom content that the user has permission to view will be returned.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; id: number; limit?: number; sort?: string; }	-
parameters.cursor?	string	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
parameters.id	number	The ID of the parent custom content. If you don't know the custom content ID, use Get custom-content and filter the results.
parameters.limit?	number	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
parameters.sort?	string	Used to sort the result by a particular field.

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; results?: object[]; }>