Request

Response

    Inputs

    PaginationInput

    input

    Specifies how to split the response into multiple pages.


    Fields

    cursorSpecifies what page to fetch. If you don’t specify cursor, fetches the first page.
    limitThe maximum number of items to return in a page. The default value for limit varies from query to query.


    Where Used

    UsageUsed ByDescription
    Argument for Query hubs Retrieves all hubs that match the specified criteria. A Hub is a container of projects, shared resources, and users with a common context.
    Argument for Query projects Retrieves all projects that match the specified filter criteria from a specified hub.
    Argument for Query foldersByFolder Retrieves all subfolders within a specified folder that meet the filter criteria specified by the filter argument.
    Argument for Query foldersByFolderInHub Retrieves all subfolders within a specified folder that meet the filter criteria specified by the filter argument.
    Argument for Query foldersByProject Retrieves all top level folders under a specified project that meet the filter criteria specified by the filter argument.
    Argument for Query itemsByFolder Retrieves all items within a specified folder that meet the filter criteria specified by the filter argument.
    Argument for Query itemsByProject Retrieves all top level items under a specified project that meet the filter criteria specified by the filter argument.
    Argument for Query searchByHub Performs a hub-wide search across supported entity types. Filter control via SearchResultTypeEnum - COMPONENT, MODEL, FOLDER, FILE(DesignItem, DrawingItem, BasicItem, ConfiguredDesignItem), PROJECT - query: Free-text query string. There is no explicit maximum length enforced for the search query string. - searchFields: [PropertyNameValuePair] to match by specific searchable properties (values OR’ed within a property & AND’ed across different searchFields entries). - desiredSearchResultTypes: [SearchResultTypeEnum] to restrict result types in Search Results; If empty or omitted, ALL supported types are returned by default (COMPONENT, MODEL, FILE, FOLDER, PROJECT). - sort: [Sort] to order results by a propertyId in ASC/DESC order. Returns SearchPayload with: - pagination: cursor and page size, - SearchPayload: - results: display name, optional thumbnail, match highlights, and the matched object (union). - SearchResultMatch { matchedPropertyId: ID!, matchedText: String! }
    Argument for Query searchablePropertiesByHub Retrieves the list of searchable properties available for the specified hub.
    Argument for Query workspaceRoles Retrieves all available roles for a specific workspace in a hub.
    Argument for Field Application Object representing an application.
    Argument for Field BasicItem Represents a basic item that does not contain components or drawings. A basic item is a container that stores data, information, settings, or commands used with a computer program.
    Argument for Field Component An object representing an item in the bill of materials (BOM). It can be a part, an assembly, a sub-assembly or an end product which is the very top-level with no parent above it.
    Argument for Field ConfiguredDesignItem Represents an item that contains configurations.
    Argument for Field DesignItem Represents an item that contains a product design.
    Argument for Field Drawing Represents a drawing containing 2D projected views of a product design.
    Argument for Field DrawingItem Represents an item that contains 2D projected views of a product design.
    Argument for Field Folder Represents a folder. A folder is a location for storing files, data, and other folders (sub-folders).
    Argument for Field Group Type Group Represents an object containing group information.
    Argument for Field Hub Represents a hub. A hub is a container of projects, shared resources, and hub members.
    Argument for Field HubMember An object representing a member of a hub.
    Argument for Field Item Represents an Item. An item refers to a file or sub-folder that exists within a folder.
    Argument for Field Model Represents a CAD model within a design. A model is an individual part or sub-assembly that acts as a single unit. For example, a lug nut is an individual model in a wheel assembly.
    Argument for Field Project Represents a project. A project is a shared workspace for teams of people working together on a project, to store, organize, and manage all related entity data.
    Argument for Field PropertyDefinitionCollection Data object that represents property definition collection.