adobe-firefly-sdk
    Preparing search index...

    Type Alias GetJobStatusData

    type GetJobStatusData = {
        body?: never;
        headers: {
            Authorization: string;
            "x-api-key": string;
            "x-gw-ims-org-id"?: string;
        };
        path: { id: string };
        query?: { page?: number; size?: number };
        url: "/v3/status/{id}";
    }
    Index

    Properties

    body? headers path query? url

    Properties

    Optionalbody

    body?: never
    headers: {
        Authorization: string;
        "x-api-key": string;
        "x-gw-ims-org-id"?: string;
    }

    Type Declaration

    • Authorization: string

      The authorization token with bearer "token_value". For example: Bearer <access_token>.

    • x-api-key: string

      The API key as defined in Adobe's Developer Console.

    • Optionalx-gw-ims-org-id?: string

      This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's Developer Console. This is optional.

    path: { id: string }

    Type Declaration

    • id: string

      The ID of the job you want to see the status of. This comes from the response of the executed job request.

    query?: { page?: number; size?: number }

    Type Declaration

    • Optionalpage?: number

      Zero-based page index to retrieve when outputs are paginated. Defaults to 0.

    • Optionalsize?: number

      Number of output items to return per page when outputs are paginated. Defaults to 10.

    url: "/v3/status/{id}"

    Settings

    Member Visibility

    On This Page

    Properties