Skip to content

Function: createSmartLinkProperty()

ts
function createSmartLinkProperty(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:193

Creates a new content property for a Smart Link in the content tree.

Permissions required: Permission to update the Smart Link in the content tree.

Parameters

ParameterTypeDescription
clientClient-
parameters{ id: number; key?: string; value?: unknown; }-
parameters.idnumberThe ID of the Smart Link in the content tree to create a property for.
parameters.key?stringKey of the content property
parameters.value?unknownValue of the content property.

Returns

Promise&lt;{ [key: string]: unknown; id?: string; key?: string; value?: unknown; version?: | { [key: string]: unknown; attachment?: Record&lt;string, any>; authorId?: string; comment?: Record&lt;string, any>; contributorIds?: unknown[]; createdAt?: Date; message?: string | null; minorEdit?: boolean; ncsStepVersion?: string | null; number?: number; } | null; }>