Querying Object-Level GraphQL APIs (System Generated)

The API is system-generated using the format ObjectName + API. Users can query the object by providing its primary key.

The response returns the record corresponding to the primary key provided in the query. Users can also select specific fields for the given API and view data only for those selected fields. Following is the query-

query MyQuery {
  standardObjApi(standardObj_id: "2") {
    is_deleted
    age
    name
    created_on
    created_by
    modified_on
    modified_by
  }
}

For historical object types, users can query objects using the primary key and, in addition to selecting required fields, can also retrieve the transaction range, effective range, and other data validity-related information from the explorer. Following is the query-

query MyQuery {
  completeSnapshotObjApi(completeSnapshotObj_id: "2") {
    age
    batchCreatedOn
    batchId
    completeSnapshotObj_external_id
    completeSnapshotObj_id
    created_by
    effectiveRange {
      end {
        inclusive
        value
      }
      start {
        inclusive
        value
      }
    }	
    is_deleted
    jobId
    modified_by
    name
    nodeId
    snapshotReferencesExternalId
    transactionRange {
      end {
        inclusive
        value
      }
      start {
        inclusive
        value
      }
    }
    transactionStart
    transactionStop
    validBegin
    validEnd
  }
}

To retrieve historical data, the appropriate validity date (valid_ts) must be passed in the request headers. If the request header is not provided and the data falls outside the current date (past or future), the response will be null, as the system evaluates historical data based on the current date by default.