GraphQL Example with Postman

The following example using Postman shows how to query the values for a single Contract User Defined Field across all contracts.

The GraphQL endpoint will be "https://<your-instance-name>-connect.contracteagle.com/graphql

Within Postman, create a new "POST" request and select "GraphQL" as the body type.


The Query

The following query returns only the Contract User Defined Fields graph node, providing the Contract Id, User Defined Field ID and the value. Since this is a contract value, we are using the numeric value, but we could alternatively return the "valueAsString" field, which would return a formatted string value for the field - in this case, because the Contract Value is normally defined as a Currency field, the value would be returned as a formatted currency string such as "$40,000". 

		query getContract(
		  $getContractFilter: ContractFilterInput
		  $getFirst: Int
		  $getAfter: String
		) {
		  contractDetails(
			inputFilter: $getContractFilter
			first: $getFirst
			after: $getAfter
		  ) {
			pageInfo {
			  hasNextPage
			  hasPreviousPage
			}
			nodes {
			  contractUserDefinedFields {
				contractId
				userDefinedFieldId
				numericValue
			  }
			}
		  }
		}

Query Variables

In this example, User Defined Field ID 22 corresponds to the "Contract Value" field:

  • We only want the Contract Value returned, so the "includeUserDefinedFieldIds" value is set to 22.
  • We only want to return contracts where the Contract Value is populated - so a filter set is created to only return contracts that have a Contract Value greater than zero recorded.

Returning a single user defined field value has low performance impact so here we are returning a page of 1000 records (getFirst: 1000).

		{
		  "getContractFilter" : {
			"includeUserDefinedFieldIds": [22],
			"contractFilterSet": [
			  {
			  "userDefinedFieldFilters": [
				{ 
				  "userDefinedFieldId": 22,
				  "matchOperator":"GREATER_THAN_OR_EQUAL" ,
				  "fieldValue": "0"
				}
			  ]
			  }
			]
			},
		  "getFirst" : 1000,
		  "getAfter" : null
		}

The Result

The result is returned as serialized JSON object. You can then iterate over the nodes array to extract the contractId and numericValue fields. 

			"data": {
				"contractDetails": {
					"pageInfo": {
						"hasNextPage": false,
						"hasPreviousPage": false
					},
					"nodes": [
						{
							"contractUserDefinedFields": [
								{
									"contractId": 1005,
									"userDefinedFieldId": 22,
									"numericValue": 420.000000
								}
							]
						},
						{
							"contractUserDefinedFields": [
								{
									"contractId": 1007,
									"userDefinedFieldId": 22,
									"numericValue": 410.000000
								}
							]
						},
			...