Get Available Data Points

GET 
/ext/integrations/sync-sdk/datapoints/

This marks the initial phase of configuring the integration. Through this API, you can either create a new instance object or retrieve an existing one. Subsequently, you will use this instance object to transmit the sync data.

Responses

200

Get Available Data Points

application/json

Schema

Schema

data

object[]

Array [

_id string

enum string

name string

schema

object

items

object

properties

object

account_name

object

type string

app

object

type string

businessUnit

object

type string

costcenter

object

type string

date_of_joining

object

format string

type string

date_of_termination

object

format string

type string

department

object

type string

designation

object

type string

email

object

type string

id

object

type string

jobTitle

object

type string

last_used

object

format string

type string

license

object

items

object

type string

type string

name

object

type string

po_number

object

type string

reportingmanager

object

type string

role

object

type string

status

object

enum string[]

transaction_amount

object

type string

transaction_currency

object

type string

transaction_date

object

format string

type string

transaction_description

object

type string

transaction_type

object

type string

vendor_name

object

type string

required string[]

type string

type string

status string

]

Example (from schema)

{
  "data": [
    {
      "_id": "651b1fb3f8845b4222953d2c",
      "enum": "transaction_information",
      "name": "Transaction Information",
      "schema": {
        "items": {
          "properties": {
            "account_name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "po_number": {
              "type": "string"
            },
            "transaction_amount": {
              "type": "number"
            },
            "transaction_currency": {
              "type": "string"
            },
            "transaction_date": {
              "format": "date-time",
              "type": "string"
            },
            "transaction_description": {
              "type": "string"
            },
            "transaction_type": {
              "type": "string"
            },
            "vendor_name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "transaction_date",
            "transaction_description",
            "transaction_amount",
            "transaction_currency"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "status": "active"
    },
    {
      "_id": "651b1f1af8845b4222953d2a",
      "enum": "user_app_information",
      "name": "User App Information",
      "schema": {
        "items": {
          "properties": {
            "app": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "last_used": {
              "format": "date-time",
              "type": "string"
            }
          },
          "required": [
            "last_used",
            "email",
            "app"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "status": "active"
    },
    {
      "_id": "6516769ca971cb05e11c7449",
      "enum": "user_information",
      "name": "Users Information",
      "schema": {
        "items": {
          "properties": {
            "businessUnit": {
              "type": "string"
            },
            "costcenter": {
              "type": "string"
            },
            "date_of_joining": {
              "format": "date-time",
              "type": "string"
            },
            "date_of_termination": {
              "format": "date-time",
              "type": "string"
            },
            "department": {
              "type": "string"
            },
            "designation": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "jobTitle": {
              "type": "string"
            },
            "last_used": {
              "format": "date-time",
              "type": "string"
            },
            "license": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "name": {
              "type": "string"
            },
            "reportingmanager": {
              "type": "string"
            },
            "role": {
              "type": "string"
            },
            "status": {
              "enum": [
                "active",
                "inactive",
                "suspended"
              ]
            }
          },
          "required": [
            "email"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "status": "active"
    }
  ]
}

Get Available Data Points

{
  "data": [
    {
      "_id": "651b1fb3f8845b4222953d2c",
      "enum": "transaction_information",
      "name": "Transaction Information",
      "schema": {
        "items": {
          "properties": {
            "account_name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "po_number": {
              "type": "string"
            },
            "transaction_amount": {
              "type": "number"
            },
            "transaction_currency": {
              "type": "string"
            },
            "transaction_date": {
              "format": "date-time",
              "type": "string"
            },
            "transaction_description": {
              "type": "string"
            },
            "transaction_type": {
              "type": "string"
            },
            "vendor_name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "transaction_date",
            "transaction_description",
            "transaction_amount",
            "transaction_currency"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "status": "active"
    },
    {
      "_id": "651b1f1af8845b4222953d2a",
      "enum": "user_app_information",
      "name": "User App Information",
      "schema": {
        "items": {
          "properties": {
            "app": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "last_used": {
              "format": "date-time",
              "type": "string"
            }
          },
          "required": [
            "last_used",
            "email",
            "app"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "status": "active"
    },
    {
      "_id": "6516769ca971cb05e11c7449",
      "enum": "user_information",
      "name": "Users Information",
      "schema": {
        "items": {
          "properties": {
            "businessUnit": {
              "type": "string"
            },
            "costcenter": {
              "type": "string"
            },
            "date_of_joining": {
              "format": "date-time",
              "type": "string"
            },
            "date_of_termination": {
              "format": "date-time",
              "type": "string"
            },
            "department": {
              "type": "string"
            },
            "designation": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "jobTitle": {
              "type": "string"
            },
            "last_used": {
              "format": "date-time",
              "type": "string"
            },
            "license": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "name": {
              "type": "string"
            },
            "reportingmanager": {
              "type": "string"
            },
            "role": {
              "type": "string"
            },
            "status": {
              "enum": [
                "active",
                "inactive",
                "suspended"
              ]
            }
          },
          "required": [
            "email"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "status": "active"
    }
  ]
}

Loading...