adobe-firefly-sdk
    Preparing search index...

    Type Alias GetProjectsData

    type GetProjectsData = {
        body?: never;
        headers?: { "x-request-id"?: string };
        path?: never;
        query?: {
            cursor?: string;
            filter?: string;
            limit?: number;
            sortBy?: string;
        };
        url: "/projects";
    }
    Index

    Properties

    body? headers? path? query? url

    Properties

    Optionalbody

    body?: never
    headers?: { "x-request-id"?: string }

    Type Declaration

    • Optionalx-request-id?: string

      The X-Request-Id header is used to identify a request. It can be used to correlate logs and other resources and is intended to be a non-persistent identifier.

    path?: never
    query?: { cursor?: string; filter?: string; limit?: number; sortBy?: string }

    Type Declaration

    • Optionalcursor?: string

      Cursor used for fetching next set of results.

      • If not provided, the first page of results is returned.
      • For subsequent pages, only the cursor should be sent.

      NOTE: The cursor is opaque and should not be parsed or modified by clients.

    • Optionalfilter?: string

      FIQL-based filter string

      Following fields are supported for filtering:

      • view: (deprecated) Filters the results to only a specific view (operators allowed are ==). Single value is only supported. The possible values are yours, all, shared_with_you, discoverable. Here is how each view works:

      • Yours:

      • Projects in the calling user's User Home storage

      • Projects in the calling user's Org's ESM shared storage for which the user has write access through membership in the _everybody group.

      • Shared with you:

      • Projects in other user's User Home storage for which the calling user has permissions

      • Projects in other Org's ESM shared storage for which the calling user has permissions

      • All:

      • Combination of Projects returned from Yours and Shared with you

      • Discoverable:

      • Projects returned from All view

      • Projects in the calling user's Org's ESM shared storage for which the user has read access through membership in the _everybody group.

      • state: Filter by project state (operators allowed are ==). Single value is only supported.

      • active (default): Filter by active projects.

      • deleted: Filter by (soft)deleted projects.

      • state: Filter by asset state (operators allowed are ==). Single value is only supported.

      • active (default): Filter by active assets.

      • deleted: Filter by (soft)deleted assets.

      • createdBy: Filter by project creator (operators allowed are == and !=). Single value is only supported.

      • current_user is a predefined constant representing the user initiating the request. Currently, this is the sole supported value.

      NOTE:

      • The view parameter is deprecated and will be removed in a future release. Clients should use the createdBy parameter instead.
      • Only applicable for the first page. Subsequent pages must use the cursor.
    • Optionallimit?: number
      • Provides a hint for the number of items per page.
      • In cases where multiple elements have the same field value used to split the page, the server may adjust the number of items returned to ensure page boundaries align correctly.
    • OptionalsortBy?: string

      Defines the sort order.

      • If not specified, the default is +name.
      • Prefix with - for descending order. + is optional for ascending order.

      Following fields are supported for sorting:

      • name
      • created

      NOTE:

      • Only applicable for the first page. Subsequent pages must use the cursor.
    url: "/projects"

    Settings

    Member Visibility

    On This Page

    Properties