Skip to content

Function: getAttachmentContentPropertiesById()

ts
function getAttachmentContentPropertiesById(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:304

Retrieves a specific Content Property by ID that is attached to a specified attachment.

Permissions required: Permission to view the attachment.

Parameters

ParameterTypeDescription
clientClient-
parameters{ attachmentId: string; propertyId: number; }-
parameters.attachmentIdstringThe ID of the attachment for which content properties should be returned.
parameters.propertyIdnumberThe ID of the content property to be returned

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; }>