Wyn Enterprise uses GraphQL to send a query to your API and obtain the required data. On this page, you will find the instructions to access GraphiQL from Admin Portal and manage various resources including,

• Access GraphiQL from Admin Portal

• Get the list of resources

• Get details of all resources

• Get details of a specific resource

• Update a resource

• Delete a resource

Access GraphiQL from Admin Portal

1. To access GraphiQL, navigate to the Admin Portal and click the graphiql link on the Dashboard under the Links section.

   
   

2. GraphiQL IDE will open in a new tab. Use the input box on the left side to enter a query and click the execute button on the top right corner your screen to get an output on the right side. You can also change the settings of the query using the Prettify, Merge, and Copy buttons on the toolbar next to the execute button. Use the History button to view the history of queries used in GraphiQL. To access the GraphiQL API documentation, click the Docs link on the top right corner of your screen.

   
   

3. In the Documentation Explorer, you can view the query and mutation documentation.

   
   

4. On clicking the PortalQuery option, you get the list of the queries used to fetch data.

   
   

5. On clicking the Mutation option, you get the list of queries used to modify data on the server side.

Get the list of resources

You may want to obtain a list of all the resources available to you. The following query returns the list of all resources along with the ID and file name of all the resources.

query
  {
     documents {
       id
       filename
     }
  }

Get details of all resources

Along with the resource ID and file name, you can also obtain other details such as title, file type, and extension, created date, created by, modified date, modified by information; and operations allowed on the resource, using additional attributes available in the API. The following table elaborates the attributes available in documents object in the previous query:

Get details of a specific resource

If you want to obtain details of a specific resource, replace the "key" in the following query with the one specified in the following table.

{
  query: documenttypes(key: "key") {
      documents {
        id
        filename      
    }
  }
}

Update a resource

Update Permissions

To update permissions, obtain the ID of the resource and put it in the following mutation.

mutation 
  {
    updatePermissions( documentId: "documentID" , 
      grant: [ { role:"TestRole",
      ops: [ Read, Update ]}] , 
      revoke: [ { role:"Everyone", ops: [ Read ]}] )
  }

Update the Category of a resource

You need to have the category ID of the resource you want to modify. See Using GraphQL to Manage Categories topic on how to obtain a category ID.

Assign a Category to a resource

Obtain the ID of the resource and the tag ID (or category ID) and put it in the following mutation to add a tag to the resource.

mutation
  { 
    tagDocument(
    tagId: "tagid",
    documentId: "documentID")
  } 

Delete Category from a resource

Obtain the ID of the resource and the tag ID (or category ID) and put it in the following mutation to delete the tag from the resource.

mutation
  {
    untagDocument(
     tagId: "tagid",
     documentId: "documentID") 
  }

Delete a resource

You need to first obtain the ID of the resource and put it in the following mutation to delete the resource.

mutation
  {    
    deleteDocument(documentId: "documentID") 
    {
      deleted_id
    }
  }