{
  "opencollection": "1.0.0",
  "info": {
    "name": "Spotio 2.0 Workflow Fields API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "WorkflowFields",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of available fields for a data object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/:dataObjectId/fields/available",
            "params": [
              {
                "name": "dataObjectId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint retrieves the list of available (not used yet) fields for a specific data object based on its ID."
        },
        {
          "info": {
            "name": "Get the list of fields for a data object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/:dataObjectId/fields",
            "params": [
              {
                "name": "dataObjectId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint retrieves the list of fields associated with a specific data object based on its ID."
        },
        {
          "info": {
            "name": "Create a new field for a data object",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/:dataObjectId/fields",
            "params": [
              {
                "name": "dataObjectId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint creates a new field and add it to a specific data object based on the provided request data."
        },
        {
          "info": {
            "name": "Update an existing field for a data object",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/:dataObjectId/fields/:id",
            "params": [
              {
                "name": "dataObjectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint updates an existing field for a specific data object based on its ID and the provided request data."
        },
        {
          "info": {
            "name": "Delete a field for a data object",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/:dataObjectId/fields/:id",
            "params": [
              {
                "name": "dataObjectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint deletes a specific field for a data object based on its ID."
        },
        {
          "info": {
            "name": "Delete a field definition",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.spotio2.com/api/workflow/fields/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint deletes a field definition based on its ID."
        },
        {
          "info": {
            "name": "Move field to the data object",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/:dataObjectId/fields/:id/move",
            "params": [
              {
                "name": "dataObjectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Add or change a field for a specific data object and update its index and role, if applicable."
        },
        {
          "info": {
            "name": "Delete a field from multiple objects",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/fields/:id/deleteReference",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete a field from multiple data objects based on their IDs."
        },
        {
          "info": {
            "name": "Get information if a field is used by any integration.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.spotio2.com/api/workflow/dataobjects/fields/:id/integrations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List of integrations that uses the this field."
        }
      ]
    }
  ],
  "bundled": true
}