Quantivate API Documentation

Each request will return X-RateLimit headers showing the Limit, Remaining Calls, and the time at which the Remaining Calls will reset to the Limit (Reset).

1. X-RateLimit-Limit – The maximum number of requests that the user is allowed to make in the time window.
2. X-RateLimit-Remaining – The number of requests remaining in the current rate limit window.
3. X-RateLimit-Reset – The time at which the current rate limit window resets in UTC epoch seconds.

There are three rate limit categories enforced on each request to the Quantivate API (IP, Token, and License):

• For any IP, you will get 10 calls per minute, beginning at the first call.  This will reset on the first request after the minute has passed.
• For your JWT, you will get 15 calls per minute, beginning at the first call.  This will reset on the first request after the minute has passed.
• For the license, you will get a number of calls (based on your MSA) for the month.  This will reset on first request of each new month.

The following are example response headers for each category:

1. Rate limit per IP
   1. X-RateLimitIP-Limit: 10
   2. X-RateLimitIP-Remaining: 5
   3. X-RateLimitIP-Reset: 1525733404
2. Rate limit per Access Token
   1. X-RateLimitJWT-Limit: 15
   2. X-RateLimitJWT-Remaining: 5
   3. X-RateLimitJWT-Reset: 1525733404
3. Rate limit per client
   1. X-RateLimitLicense-Limit: 100
   2. X-RateLimitLicense-Remaining: 34
4. X-RateLimitLicense-Reset: 1527894471

When an application exceeds any of the rate limits, the API will return a HTTP 429 “Too Many Requests” response code, and the following errors will be returned in the response body:

{"error":{"message":"Too many requests for this IP","code":429}}
{"error":{"message":"Too many requests for this JWT","code":429}}
{"error":{"message":"Licensed API calls for the month used up","code":429}}

See the following examples for a basic API call.  For other methods, you will replace the “method” and “params” properties with the desired method name and respective parameters.

https://api.quantivate.com/
?jwt=<token>&rpc=
{"method":"getResource","params":{"resourceTypeName":"Vendor","resourceName":"AAA"}}

curl --request GET \
     --header "Authorization: Bearer <token>" \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"method\": \"getResource\", 
    \"params\": 
    {                
        \"resourceTypeName\": \"Vendor\",
        \"resourceName\": \"AAA\"
    }
}" \
'https://api.quantivate.com'

Example Error Response:

{
    "error":  
    {                
        "message": "No resource of type 'Vendor' exists or resource is in trash bin with name: 'AAA'",
        "code": 5
    }
}

Parameters

Each method accepts parameters that are required. Below is a list of all possible parameter types that can be placed in the JSON object nested under the “params” property. A given parameter may be used by more than one method. See section titled “Methods” for a list of parameters required for each specific JSON-RPC method.

Parameter “attributes” and “tableAttributes”

Key value pairs of attribute names in a resource type and accepted data for the attribute type:

The following section includes a description and other details on the various methods that can be called using the Quantivate API to interact with your data.

Use this method to create a resource with the given attributes. The name of the resource will be set to the value provided for the attribute that is set to default in the Quantivate platform

Parameters:

• resourceTypeName
• attributes

Request Body:

{
    "method": "addResource",
    "params": 
    {
        "resourceTypeName": "Vendor",
        "attributes": {
            "Vendor Name": "Dunk n Donuts",
            "State": "WA",
            "Zip Code": 98072,
            "Associated Employee": "Smith, John A"
        }
    }
}

Returns:

• JSON object with resource information on Success, or error message

Errors:

• Invalid Resource Type
• Fail constraints: Unique, Required
• Fail Attribute format requirements
• Date – bad format
• Employee – employee doesn’t exist
• Select – option doesn’t exist
• Select Multiple – option doesn’t exist
• Checkbox – invalid value
• Number – not a number
• Currency – not a valid currency
• Attribute does not exist
• Attribute type cannot be updated via this method

{  
    "method":"updateResource",
    "params": { 
        "resourceTypeName":"Vendor", 
        "resourceName":"AAA Washington",
        "attributes": {
            "Vendor Name": "Donuts",  
            "State":"WA",
            "Zip Code":98072
        }
    }
}

Returns:

• JSON object with resource information on Success, or error message

Errors:

• Invalid Resource Type
• Fail constraints: Unique, Required
• Fail Attribute format requirements
• Date – bad format
• Employee – employee doesn’t exist
• Select – option doesn’t exist
• Select Multiple – option doesn’t exist
• Checkbox – invalid value
• Number – not a number
• Currency – not a valid currency
• Attribute does not exist
• Attribute type cannot be updated via this method

Request Body:

{
    "method": "trashResource",
    "params": {
        "resourceName": "Quantivate",
        "resourceTypeName": "Vendor"
    }
}

Response:

{
    "result": "Success"
}

Use this method to retrieve data from a resource report in Quantivate

Parameters:

• reportName

Request Body:

{
    "method": "runResourceReport",
    "params": {
        "reportName": "All Vendors"
    }
}

Response:

{
    "columns": ["Vendor Name", "Vendor Description",...],
    "data": [
        ["Quantivate", "The best vendor ever",...],
        ["Dunk'n Donuts", "The second best vendor",...],
        ...
     ]
}

Gives ownership of a resource to the given group

Parameters:

• groupName
• resourceTypeName
• resourceName

Request Body:

{
    "method": "addGroupOwnership",
    "params":
    {
        "groupName": "Accounts Payable",
        "resourceTypeName": "Vendor",
        "resourceName": "Quantivate"
    }
}

Response:

{
    "result": "Success"
}

Errors:

• More than one group exists with name: ‘<groupName>’
• No Group exists with name: ‘<groupName>’
• Resource type does not exist
• No required unique default attribute found for resource type
• No resource of type ‘<Resource Type>’ exists or resource is in trash bin with name: ‘<Resource Name>’
• More than one <Resource Type Name> exists with name: <Resource Name>

Revokes ownership of a resource from a group

Parameters:

• groupName
• resourceTypeName
• resourceName

Request Body:

{
    "method": "removeGroupOwnership",
    "params":
    {
        "groupName": "Accounts Payable",
        "resourceTypeName": "Vendor",
        "resourceName": "Quantivate"
    }
}

Response:

{
    "result": "Success"
}

Assigns an employee to a group with the given role

Parameters:

• groupName
• employeeName
• role (“Group Viewer” or “Group Modifier”)

Request Body:

{
    "method": "setGroupMembership",
    "params":
    {
        "groupName": "Accounts Payable",
        "employeeName": "Smith, John A",
        "role": "Group Viewer"
    }
}

Response:

{
    "result": "Success"
}

Revokes membership into a group from the given employee

Parameters:

• groupName
• employeeName

Request Body:

{
    "method": "removeGroupMembership",
    "params":
    {
        "groupName": "Accounts Payable",
        "employeeName": "Smith, John A",
    }
}

Response:

{
    "result": "Success"
}

Errors:

• More than one group exists with name: ‘<groupName>’
• No Group exists with name: ‘<groupName>’
• More than one employee exists with name: <employeeName>
• Employee does not exist: ‘<employeeName>’

Links an upstream (dependency) resource to a downstream (customer) resource

Parameters:

• upstreamResourceTypeName
• upstreamResourceName
• downstreamResourceTypeName
• downstreamResourceName

Request Body:

{
    "method": "linkResources",
    "params":
    {
        "upstreamResourceTypeName": "Vendor",
        "upstreamResourceName": "Quantivate",
        "downstreamResourceTypeName": "Vendor",
        "downstreamResourceName": "15 Year Contract"
    }
}

Response:

{
    "result": "Success"
}

Errors:

• Resource type does not exist
• No required unique default attribute found for resource type
• No resource of type ‘<Resource Type>’ exists or resource is in trash bin with name: ‘<Resource Name>’
• More than one <Resource Type Name> exists with name: <Resource Name>

Adds a row to a table in the given resource

Parameters:

• resourceTypeName
• resourceName
• tableName
• tableAttributes and values

Request Body:

{
    "method": "addTableRow",
    "params": {
        "resourceTypeName": "Vendor",
        "resourceName": "Quantivate",
        "tableName": "Spend items",
        "tableAttributes": {
            "Recipient": "Donuts R Us",
            "Date": "12/31/1999",
            "Amount": "98,072.00",
            "Purchaser": "Smith, John A"
        }
    }
}

Response:

{
    "result": "Success"
}

The table below provides a list of general errors or exceptions that can be returned by the API.

Errors and Codes