Skip to main content

Meta

Overview​

tip

All endpoints in this service use the Base URL of /meta

1. Get Info About Me​

  • Endpoint: /custom/me
  • Method: GET
  • Summary: Retrieves information about the currently authenticated user

Request Parameters:​

  • No request parameters are required.

Response:​

{
  "id": "GUID",
  "firstName": "Bob",
  "lastName": "Smith",
  "name": "Bob Smith",
  "created": "2024-12-11T09:05:24.453Z",
  "lastModified": "2025-02-11T01:40:44.638Z",
  "employees": [
    "25e89fce-2e0d-4ba7-83bf-2898c899c310"
  ],
  "custom": {
    // The contacts metadata for this person
  }
}

2. Explain an attribute​

  • Endpoint: /explain
  • Method: POST
  • Summary: Provides an explanation of how a rule is defined within your underlying Decisively model.

Request Parameters:\​

Provide the attribute GUID from Decisively of the attribute you would like explained and the session GUID of the session/timesheet that contains the data you are inspecting against.

{
  "attribute": "GUID",
  "session": "GUID"
}

Response:​

{
  "inputs": [
    {
      "id": "89dcdf11-bc35-42e0-b647-2cc21e55514f",
      "path": "employees/1/89dcdf11-bc35-42e0-b647-2cc21e55514f",
      "description": "the total on-call allowance payable to the employee (ordinary hours)",
      "derived": 2.65,
      "index": "1",
      "entity": "employees",
      // additional elements may appear depending on your Decisively model 
    }
  ],
  "relationships": [], // an array of the relationships within your Decisively data model. Provided so that you can use the singular and plural forms of relationship names within rules. 
  "node": {} // The node definition of the attribute being explained. Use this to determine the specific rules. It follows a similar structure to the example input above, and will differ depending on your Decisively model
}

3. Get Analytics​

  • Endpoint: /analytics
  • Method: GET
  • Summary: Retrieves analytics data.

Request Parameters:​

  • startDate (required, string): The start date for the analytics query. It will use the configured data span (default: fortnight) to collect data from this start date until the configured end.

Response:​

  • Placeholder for response example.
{
  "timesheets": ["approved", "missing"] // an array of statuses
}

4. Read Settings for a Tenancy​

  • Endpoint: /settings/{id}
  • Method: GET
  • Summary: Retrieves the settings for a specific tenancy.

Request Parameters:​

  • id (required, string): The tenancy ID.

Response:​

{
  "locale": {
    "fullDate": "dd/MM/yyyy",
    "fullDateTime": "yyyy-MM-dd HH:mm:ss",
    "shortDate": "EEE, dd MMM"
  },
  "mapping": {
    // Various mapping settings
  },
  "release": "GUID", // The Decisively release to use. Blank if it will simply use the most current version in your environment
  "model": "GUID" // The Decisively model/project that contains your rule base
}

5. Set Settings for a Tenancy​

  • Endpoint: /settings/{id}
  • Method: PATCH
  • Summary: Updates the settings for a specific tenancy.

Request Parameters:​

  • id (required, string): The tenancy ID.

Response:​

See the response for getting the settings.

Authentication​

Please refer to the authentication guide to understand how to authenticate your requests before interacting with the API.

Error Handling​

Please refer to the error handling guide for details on common errors and how to handle them.