Introduction

This document presents how you can work with GraphQL APIs to integrate with Sage Distribution and Manufacturing Operations (SDMO) using all the platform tools.

It explains how to get credentials, configure the application, and use the token to access the tenant.

After a small introduction to GraphQL, this document describes the structure of the GraphQL schema used by SDMO.

You can then find queries and mutations in GraphQL examples.

Index

1. Get your developer credentials

2. Configure your tenant to accept incoming APIs

3. How to get the tenant ID

4. How to get access to the tenant

5. Use of GraphQL for queries and mutations
   1. Values format
      1. Values format
      2. Character strings
      3. Enumerations
      4. Dates
      5. Amounts
      6. References
   2. Identify natural keys and enumerations
6. Examples of GraphQL operations: Queries
   1. Packages hierarchy
   2. Simple query: Read
   3. Simple list query
   4. Filters and counts on queries
   5. Ordered list
   6. Long lists: Paging
   7. Read with aggregation
   8. Query with aggregation
7. Examples of GraphQL operations: Queries with filters and counts
   1. Access to properties
   2. And and Or
   3. At least and At most
   4. Combining several conditions
   5. Comparison
   6. Conditions on references
   7. Equality
   8. In and Not in
   9. Regular expressions
8. Examples of GraphQL operations: Mutations
   1. Mutation: Record creation
   2. Mutation: Record update
   3. Mutation: Record deletion
   4. Mutation: Bulk update
   5. Mutation: Asynchronous
   6. Mutation: Managing attachments through GraphQL APIs
9. Custom fields management
   1. Custom property
   2. Operator to get a single custom property value
   3. Aggregate queries
   4. Filters
   5. Order By
   6. Mutations
10. API usage best practices