Request

Response

    Queries

    projects

    query

    Get all projects under a collection

    See the asset query for a full description of possible errors.

    Template for Query:

    query GetProjects($input: GetProjectsInput!) {
      projects(input: $input) {
        # Projects Fields
      }
    }
    

    Template for Query Variables:

    {
      "input" : "<SOME-GETPROJECTS-INPUT
    }
    


    Arguments

    input*
    * Required

    Possible Returns

    Value TypeDescription
    ProjectsPayload Response from the _projects_ query


    Examples

    Example 1

    Retrieves all projects under a hub by hub ID.

    Query:

    query GetProjects($hubId: ID!, $filter: ProjectFilterInput) {
           projects(hubId: $hubId, filter: $filter) {
               results {
                   name
                   id
                   __typename
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "hubId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4",
     "filter": {
         "name": "DOCS_STG"
     }
    }
    

    Response:

    {
       "data": {
           "projects": {
               "results": [
                   {
                       "name": "DOCS_STG",
                       "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE",
                       "__typename": "Project"
                   }
               ]
           }
       }
    }
    
    Show More