Function: updateCustomContentPropertyById()
ts
function updateCustomContentPropertyById(client, parameters): Promise<{
[key: string]: unknown;
id?: string;
key?: string;
value?: unknown;
version?: | {
[key: string]: unknown;
attachment?: Record<string, any>;
authorId?: string;
comment?: Record<string, any>;
contributorIds?: unknown[];
createdAt?: Date;
message?: string | null;
minorEdit?: boolean;
ncsStepVersion?: string | null;
number?: number;
}
| null;
}>;Defined in: src/v2/api/contentProperties.ts:530
Update a content property for a piece of custom content by its id.
Permissions required: Permission to edit the custom content.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { customContentId: number; key?: string; propertyId: number; value?: unknown; version?: | { [key: string]: unknown; message?: string; number?: number; } | null; } | - |
parameters.customContentId | number | The ID of the custom content the property belongs to. |
parameters.key? | string | Key of the content property |
parameters.propertyId | number | The ID of the property to be updated. |
parameters.value? | unknown | Value of the content property. |
parameters.version? | | { [key: string]: unknown; message?: string; number?: number; } | null | New version number and associated message |
Returns
Promise<{ [key: string]: unknown; id?: string; key?: string; value?: unknown; version?: | { [key: string]: unknown; attachment?: Record<string, any>; authorId?: string; comment?: Record<string, any>; contributorIds?: unknown[]; createdAt?: Date; message?: string | null; minorEdit?: boolean; ncsStepVersion?: string | null; number?: number; } | null; }>