GraphQL API - Postman integration

Introduction

The PSO data dispatch service uses a GraphQL api for PSO data extraction. Postman has a convenient GraphQL client to help us query the API.

GraphQL APIs have “introspection queries” that provide the client with information about the data that can be retrieved. This means that with zero documentation you can explore the possible data to be retrieved.

Postman integration

1. Create a new request

2. Choose GraphQL

3. Enter GraphQL API URL:

   Preprod https://cfk-ppd.peoplespheres.com/pso-data-dispatch-service/api/v1/pso/graphql

4. Authorization

   1. Choose OAuth2

   2. See https://peoplespheres.atlassian.net/wiki/x/BAAeag for the detail

5. On the schema tab, fire the introspection query

   It should become a “tick”

6. Query tab has the query operations available

7. Choose one of then

8. Fill the query,

9. Clic on the “Query” button to launch the request.

Postman limitation

For the getPsoRecordsquery, the “fields” argument can not be set by using the Query wizard, because List arguments are not currently supported by Postman (Postman v11.21.0 Last checked on Dec 4, 2024)

It must be set in the editable query panel:

How to do pagination?

The following query:

Give the following result:

{
    "data": {
        "getPsoTypes": {
            "edges": [
                {
                    "node": {
                        "alias": "usr",
                        "isActive": true,
                        "systemRequired": true,
                        "createdAt": "2019-03-01T10:00:54Z",
                        "updatedAt": "2019-03-01T10:00:54Z"
                    },
                    "cursor": "MQ=="
                },
                {
                    "node": {
                        "alias": "mdl",
                        "isActive": true,
                        "systemRequired": true,
                        "createdAt": "2019-03-01T10:00:55Z",
                        "updatedAt": "2019-03-01T10:00:55Z"
                    },
                    "cursor": "Mg=="
                }
            ],
            "totalCount": 16,
            "pageInfo": {
                "startCursor": "MQ==",
                "endCursor": "Mg==",
                "hasNextPage": true,
                "hasPreviousPage": false
            }
        }
    },
    "errors": null
}

To do pagination, set a cursor value into the after parameter, in over example, the last cursor is Mg==

So the next request will have a response which start after the last returned PSO.

The response:

{
    "data": {
        "getPsoTypes": {
            "edges": [
                {
                    "node": {
                        "alias": "onb",
                        "isActive": false,
                        "systemRequired": false,
                        "createdAt": "2020-05-20T10:28:13Z",
                        "updatedAt": "2020-05-20T10:35:52Z"
                    },
                    "cursor": "Mw=="
                },
                {
                    "node": {
                        "alias": "com",
                        "isActive": false,
                        "systemRequired": false,
                        "createdAt": "2020-05-20T10:36:32Z",
                        "updatedAt": "2023-05-05T09:06:44Z"
                    },
                    "cursor": "NA=="
                }
            ],
            "totalCount": 16,
            "pageInfo": {
                "startCursor": "Mw==",
                "endCursor": "NA==",
                "hasNextPage": true,
                "hasPreviousPage": true
            }
        }
    },
    "errors": null
}