Function: getCustomContentLabels()

function getCustomContentLabels(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/label.ts:71

Returns the labels for a specific piece of custom content. 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 view the custom content and its corresponding space. Only labels that the user has permission to view will be returned.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; id: number; limit?: number; prefix?: "global" | "my" | "team" | "system"; 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 custom content for which labels should be returned.
parameters.limit?	number	Maximum number of labels 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.prefix?	"global" | "my" | "team" | "system"	Filter the results to labels based on their prefix.
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[]; }>