tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > PublishingService > getPublishTransactions

PublishingService.getPublishTransactions() method

Gets a list of all publishing transactions. This operation returns an instance of ‘PublishTransaction’ type.

Signature:

static getPublishTransactions({ userId, publicationId, targetTypeId, startDate, endDate, priority, state, details, }: {
        userId?: string;
        publicationId?: string;
        targetTypeId?: string;
        startDate?: string;
        endDate?: string;
        priority?: 'Low' | 'Normal' | 'High';
        state?: 'ScheduledForPublish' | 'WaitingForPublish' | 'InProgress' | 'ScheduledForDeployment' | 'WaitingForDeployment' | 'Failed' | 'Success' | 'Warning' | 'Resolving' | 'Rendering' | 'Throttled' | 'ReadyForTransport' | 'Transporting' | 'Deploying' | 'PreparingDeployment' | 'PreCommittingDeployment' | 'CommittingDeployment' | 'WaitingForCdEnvironment' | 'UnknownByClient';
        details?: 'IdAndTitleOnly' | 'WithApplicableActions' | 'Contentless';
    }): CancelablePromise<Array<PublishTransaction>>;

Parameters

Parameter	Type	Description
{ userId, publicationId, targetTypeId, startDate, endDate, priority, state, details, }	{ userId?: string; publicationId?: string; targetTypeId?: string; startDate?: string; endDate?: string; priority?: ‘Low’ | ‘Normal’ | ‘High’; state?: ‘ScheduledForPublish’ | ‘WaitingForPublish’ | ‘InProgress’ | ‘ScheduledForDeployment’ | ‘WaitingForDeployment’ | ‘Failed’ | ‘Success’ | ‘Warning’ | ‘Resolving’ | ‘Rendering’ | ‘Throttled’ | ‘ReadyForTransport’ | ‘Transporting’ | ‘Deploying’ | ‘PreparingDeployment’ | ‘PreCommittingDeployment’ | ‘CommittingDeployment’ | ‘WaitingForCdEnvironment’ | ‘UnknownByClient’; details?: ‘IdAndTitleOnly’ | ‘WithApplicableActions’ | ‘Contentless’; }

Returns:

CancelablePromise<Array<PublishTransaction>>

PublishTransaction The request was successful.

Exceptions

ApiError