getPsoRecords

Description

The getPsoRecords query retrieves the field values for each PSO in the application.

Inputs

  • Credentials: Used to specify the target application from which the data should be retrieved.

  • PSO Type (required): Specifies the type of PSO to query. This can be obtained using the getPsoTypes query.

  • Field Aliases (required): A list of field aliases for the PSO type. These can be obtained using the getPsoFields query. The aliases should be provided as an array.

Response JSON

For each provided field alias, the response includes:

  • The current value of the field in the application.

  • The externalId of the PSO.

Filters

You can refine the query results using the following filters:

  1. By PSO External ID: Retrieve field values for a specific PSO by providing its externalId.

  2. By Field Alias and Values: Filter by multiple field values. Provide a JSON object containing:

    • The alias of the field.

    • The desired value for that field.

Example

Query

query GetPsoRecords {
    getPsoRecords(
        alias: "usr"
        fields: ["professional_phone", "professional_email", "usr_first_name", "usr_last_name"]
        first: 2
    ) {
        totalCount
        pageInfo {
            startCursor
            endCursor
            hasNextPage
            hasPreviousPage
        }
        edges {
            cursor
            node {
                externalId
                createdAt
                psoAlias
                fieldAliasAndValue
            }
        }
    }
}

Response

{
    "data": {
        "getPsoRecords": {
            "totalCount": 2629,
            "pageInfo": {
                "startCursor": "Ng==",
                "endCursor": "Nw==",
                "hasNextPage": true,
                "hasPreviousPage": false
            },
            "edges": [
                {
                    "cursor": "Ng==",
                    "node": {
                        "externalId": "a8438634-df47-4b5f-8d74-1ccccb999bc8",
                        "createdAt": "2019-07-11T09:38:42Z",
                        "psoAlias": "usr",
                        "fieldAliasAndValue": {
                            "professional_phone": "null",
                            "usr_last_name": "Talend",
                            "usr_first_name": "Admin",
                            "professional_email": "[email protected]"
                        }
                    }
                },
                {
                    "cursor": "Nw==",
                    "node": {
                        "externalId": "88ef9201-4c46-46b3-b789-adb992398925",
                        "createdAt": "2019-07-11T09:39:08Z",
                        "psoAlias": "usr",
                        "fieldAliasAndValue": {
                            "professional_phone": "007007007",
                            "usr_last_name": "Consultant",
                            "usr_first_name": "Admin",
                            "professional_email": "[email protected]"
                        }
                    }
                }
            ]
        }
    },
    "errors": null
}

Example with filtering

Query

A filter on the externalId

query GetPsoRecords {
    getPsoRecords(
        alias: "usr"
        fields: ["professional_phone", "professional_email", "usr_first_name", "usr_last_name"]
        first: 2
        filter: { externalId: "a8438634-df47-4b5f-8d74-1ccccb999bc8" }
    ) {
        totalCount
        pageInfo {
            startCursor
            endCursor
            hasNextPage
            hasPreviousPage
        }
        edges {
            cursor
            node {
                externalId
                createdAt
                psoAlias
                fieldAliasAndValue
            }
        }
    }
}

Response

{
    "data": {
        "getPsoRecords": {
            "totalCount": 1,
            "pageInfo": {
                "startCursor": "Ng==",
                "endCursor": "Ng==",
                "hasNextPage": false,
                "hasPreviousPage": false
            },
            "edges": [
                {
                    "cursor": "Ng==",
                    "node": {
                        "externalId": "a8438634-df47-4b5f-8d74-1ccccb999bc8",
                        "createdAt": "2019-07-11T09:38:42Z",
                        "psoAlias": "usr",
                        "fieldAliasAndValue": {
                            "professional_phone": "null",
                            "usr_last_name": "Talend",
                            "professional_email": "[email protected]",
                            "usr_first_name": "Admin"
                        }
                    }
                }
            ]
        }
    },
    "errors": null
}

Last updated