adobe-firefly-sdk
    Preparing search index...

    Type Alias ExecuteCustomScriptData

    type ExecuteCustomScriptData = {
        body: BaseJobRequestWithOutput;
        headers: {
            Authorization: string;
            "x-api-key": string;
            "x-gw-ims-org-id"?: string;
        };
        path: { script_id: string; script_name: string };
        query?: never;
        url: "/v3/{script_id}/{script_name}";
    }
    Index

    Properties

    body headers path query? url

    Properties

    body

    body: BaseJobRequestWithOutput

    This job request object specifies parameters for the execution of the custom script.

    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: { script_id: string; script_name: string }

    Type Declaration

    • script_id: string

      script_id as reported in the response to custom script submit request.

    • script_name: string

      The name of the custom script, specified in the custom script manifest.

    query?: never
    url: "/v3/{script_id}/{script_name}"

    Settings

    Member Visibility

    On This Page

    Properties