1. Resolver Core
  2. Administration
  3. Administration Overview
  4. Tools
  5. Swagger Docs
  6. API Endpoints

API Endpoints for Formulas

Updated

Overview

The formulas endpoint allows an Administrator to retrieve the formulas added to an object type and their ranges, and add, delete, and edit formulas.

POST/data/postProcess/dataImport/formulas

The POST/data/postProcess/dataImport/formulas call recalculates all formulas imported into the system using the data import feature.

Parameters:

  • org: Enter the org ID number where you want to recalculate imported formulas. Please refer to the Locating an Org's ID article for further information on locating an org's ID.
  • chuckSize: Enter a numeric value to retrieve a specific number of records instead of retrieving the whole dataset.
  • msInterval: Enter a fixed time delay that will occur between each API call in milliseconds.

Parameters

Execute:

  1. Click the Execute button to recalculate all formulas imported into the system using the data import feature.

Execute Button

  1. The OK response will display in the Response Body under the Server Response section when the formula recalculation is successful.

Server Response Body

GET/object/objectType/formulas

The GET/object/objectType/formulas call to retrieve all formulas for an object type.

Parameters:

  • objectTypeId: Enter the object type ID number that you want to delete. Users can use the GET/object/objectType call to locate an object type's ID number.

Parameters

Execute:

  1. Click the Execute button to retrieve all formulas for an object type.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

Payload:

Payload

GET/object/objectType/formulas/byIds

The GET/object/objectType/formulas call retrieves formulas using formula ID.

Parameters:

  • formulaIds: Enter a formula ID. Users can locate a formula ID by using the GET/object/objectType/formulas endpoint.
  • includeRanges: Users can include the formula's range values, if applicable, by selecting one of the following options from the dropdown menu:
    • true: Includes a formula's range values.
    • false: Does not include a formula's range values.
  • groupBy: 

Parameters

Execute:

  1. Click the Execute button to retrieve a list of formulas and their ranges.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

Payload:

  • false: Does not include formula ranges by selecting false from the includRanges parameter dropdown menu.

false payload

  • true: Include formulas range values by selecting true from the includeRanges parameter dropdown menu.

Payload

GET/object/objectType/formulas/filterById

The GET/object/objectType/formulas/filterById call retrieves a list of formula IDs using a pre-configured filter option.

Parameters:

  • formulaIds: Enter formula IDs. Users can locate a formula ID by using the GET/object/objectType/formulas endpoint.
  • filter: A pre-configured filter option.
  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.

Parameters

Execute:

  1. Click the Execute button to retrieve a list of formulas.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

GET/object/objectType/{objectTypeId}/formulas

The GET/object/objectType/{objectTypeId}/formulas call retrieves a list of formulas for an object type.

Parameters:

  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.

Parameters

Execute:

  1. Click the Execute button to retrieve a list of formulas by object type.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

Payload:

Payload

POST/object/objectType/{objectTypeId}/formulas

The POST/object/objectType/{objectTypeId}/formulas call allows a user to add a formula to an object type.

Parameters:

  1. Click on the Click to populate example field to populate the Body field with the information needed to add a new formula to an object type.

Click to Populate Example Field

  1. Delete the value between the parentheses (e.g., string, 0, etc.) and enter the new value between the two parentheses.
  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.
  • externalRefId: Enter the object type's external reference ID.
  • body:
    • name: Enter the name of the new formula.
    • script: Enter the formula values (e.g., COUNT > = 1, PRIORITY, etc.).
    • format: Enter the formula's format (e.g., None = Null, Numeric, or Date).
    • formatStyle: Enter the format's style (e.g., None = 0, Numeric = 1, Date = 2).
    • rangeStyle: Enter the formula's range style (e.g., None = 0, Label = 1, Label and Results = 2, Results = 3).
    • type: Enter the formula's type.
    • externalRefId: Enter the formula's external reference ID, used to identify the formula throughout the system.
    • description: Enter the formula's description.

Parameters

Execute:

  1. Click the Execute button to add a formula to an object type.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

  • id: Indicates the formula's record ID.

DELETE/object/objectType/{objectTypeId}/formulas/{id}

The DELETE/object/objectType/{objectTypeId}/formulas/{Id} call allows a user to delete a formula from an object type.

Parameters:

  • id: Enter formula IDs. Users can locate a formula ID by using the GET/object/objectType/formulas endpoint.
  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.

Parameters

Execute:

  1. Click the Execute button to delete the object type.

Execute Button

  1. The delete success response will be displayed in the Response Body under the Server Response section, indicating the formula was successfully deleted.

Server Response Body

GET/object/objectType/{objectTypeId}/formulas/{id}

The GET/object/objectType/{objectTypeId}/formulas/{id} call retrieves a formula. 

Parameters:

  • id: Enter formula IDs. Users can locate a formula ID by using the GET/object/objectType/formulas endpoint.
  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.

Parameters

Execute:

  1. Click the Execute button to retrieve a list of formulas by object type.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

PUT/object/objectType/{objectTypeId}/formulas/{id}

The PUT/object/objectType/{objectTypeId}/formulas/{id} call allows a user to update a formula. 

Parameters:

  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.
  • id: Enter formula IDs. Users can locate a formula ID by using the GET/object/objectType/formulas endpoint.
  • externalRefId: Enter the formula's external reference ID, used to identify the formula throughout the system.
  1. Click on the Click to populate example field to populate the Body field with the information needed to update an object type.

Click to Populate Example Field

  1. Delete the value between the parentheses (e.g., string, 0, etc.) and enter the new value between the two parentheses. 
  2. Only enter values in the parameters you want to update on the object type.
  • body:
    • name: Enter a new formula's name.
    • script: Enter new formula variables (e.g., COUNT > = 1, PRIORITY, etc.).
    • format: Enter a new formula's format (e.g., None = Null, Numeric, or Date).
    • formatStyle: The format's style (e.g., None = 0, Numeric = 1, Date = 2).
    • rangeStyle: The formula's range style (e.g., None = 0, Label = 1, Label and Results = 2, Results = 3).
    • type: Enter a new formula type.
    • externalRefId: The formula's external reference ID.
    • description: Enter a new formula description.

Parameters

Execute:

  1. Click the Execute button to apply the update to the object type.

Execute Button

  1. The update success request will be displayed in the Response Body under the Server Response section, indicating the object type was updated successfully.

Server Response Body

GET/object/objectType/{objectTypeId}/formulas/{id}/check

The GET/object/objectType/{objectTypeId}/formulas/{id}/check call checks the validity of a formula within an org and fixes broken redis (Remote Directory Server) states.

Parameters:

  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.
    id:     Enter formula IDs. Users can locate a formula ID by using the GET/object/objectType/formulas endpoint.
  • fix: Select a fix option from the fix dropdown menu:
    • True: Checks the validity of all formulas within an org and fixes any redis states.
    • False: Checks the validity of all formulas within an org without fixing any redis states.

Parameters

Execute:

  1. Click the Execute button to check the validity of a formula within an org and fix any redis states if the True option was selected under the fix parameter.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

Payload:

Payload

POST/object/objectType/{objectTypeId}/transition/{transitionId}/formulas

The POST/object/objectType/{objectTypeId}/transition/{transitionId}/formulas call adds a formula to a transition ID.

Parameters:

  • objectTypeId: Enter the object type id associated with the formula IDs. Users can locate an object type ID by using the GET/object/objectType endpoint.
  • transitionId: Enter the transition ID. Users can locate a transition ID by using the GET/object/objectType/{objectTypeId}/formulas endpoint.
  1. Click on the Click to populate example field to populate the Body field with the information needed to add a formula to a transition ID.

Click to Populate Example Field

  1. Delete the value between the parentheses (e.g., string, 0, etc.) and enter the new value between the two parentheses.
  • name: Enter the formula name.
  • script: The formula's variables (e.g., COUNT > = 1, PRIORITY, etc.).
  • format: The formula's format (e.g., None = Null, Numeric, or Date).
  • formatStyle: The format's style (e.g., None = 0, Numeric = 1, Date = 2).
  • rangeStyle: The formula's range style (e.g., None = 0, Label = 1, Label and Results = 2, Results = 3).
  • type: The formula's type.
  • externalRefId: The formula's external reference ID.
  • description: The formula's description

Parameters

Execute:

  1. Click the Execute button to add a formula to a transition ID.

Execute Button

  1. The requested data will be displayed in the Response Body under the Server Response section.

Server Response Body

  • id: Indicates the formula's record ID.
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more