System views

System views are pre-defined query filters for objects. Each time you get a view, the response includes all data that matches the filtering and sorting options set up in the view.

Get a system view

get/objects/core/system-view

Returns all system views for an object or a specified system view.

SecurityOAuth2
Request
query Parameters
name
required
string

The name of a system view, in the form <application-name>/<object name> to get all views defined for an object or <application-name>/<object name>::<view ID> to get a specific system view.

Example: name=accounts-payable/vendor::systemVendorFW1
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "string",
    • "id": "string",
    • "name": "string",
    • "href": "string",
    • "description": "string",
    • "object": "string",
    • "query": {
      • "object": "accounts-payable/vendor",
      • "fields": [
        ],
      • "filters": [
        ],
      • "filterExpression": "(1 and 2) or 3",
      • "filterParameters": {
        },
      • "orderBy": [
        ],
      • "start": 1,
      • "size": 100
      },
    • "contexts": [
      • "string"
      ]
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Query system views
post/services/core/query
Use the query service to find system views that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}