{
  "opencollection": "1.0.0",
  "info": {
    "name": "Macrometa API Reference Activity Metrics Collections API",
    "version": "0.17.17"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "excludeSystem",
                "value": "",
                "type": "query",
                "description": "Whether or not system collections should be excluded from the result."
              }
            ]
          },
          "docs": "Fetch the list of all collections."
        },
        {
          "info": {
            "name": "Create collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create collection."
        },
        {
          "info": {
            "name": "Get the information about collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "The name of the collection."
              }
            ]
          },
          "docs": "Fetch the information about collection."
        },
        {
          "info": {
            "name": "Remove collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "The name of the collection to remove."
              },
              {
                "name": "isSystem",
                "value": "",
                "type": "query",
                "description": "Whether or not the collection to remove is a system collection. This parameter must be set to *true* in order to remove system collections."
              }
            ]
          },
          "docs": "Remove the collection."
        },
        {
          "info": {
            "name": "Get workflows",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/workflows",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "Fabric name of the resource."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "Collection name."
              }
            ]
          },
          "docs": "Retrieve details of assigned workflows to a collection."
        },
        {
          "info": {
            "name": "Create a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/workflows",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "Fabric name of the resource."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "Collection name."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new workflow to an external data source or target from an existing collection."
        },
        {
          "info": {
            "name": "Remove workflow",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/workflows/:workflow-name",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "Fabric name of the resource."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "Collection name."
              },
              {
                "name": "workflow-name",
                "value": "",
                "type": "path",
                "description": "Name of the workflow."
              }
            ]
          },
          "docs": "Remove a workflow from a collection."
        },
        {
          "info": {
            "name": "Retrieve additional collection metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/metadata",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "Fabric name of the resource."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "Collection name."
              }
            ]
          },
          "docs": "Retrieve metadata related to the collection."
        },
        {
          "info": {
            "name": "Update collection metadata",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/metadata",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "Fabric name of the resource."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "Collection name."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update metadata related to the collection."
        },
        {
          "info": {
            "name": "Truncate and reload data",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/reload",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "Fabric name of the resource."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "Collection name."
              }
            ]
          },
          "docs": "Truncate the collection and reload data from source connection."
        },
        {
          "info": {
            "name": "Get number of documents in a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/count",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "The name of the collection."
              }
            ]
          },
          "docs": "Retrieve the count of documents within the collection.\n\n**Note**: This always loads the collection into memory."
        },
        {
          "info": {
            "name": "Return figures of a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/figures",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "The name of the collection."
              }
            ]
          },
          "docs": "Returns an object containing statistics about a collection.\n\n**Note**: This always loads the collection into memory."
        },
        {
          "info": {
            "name": "Truncate collection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/truncate",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "The name of the collection."
              }
            ]
          },
          "docs": "Remove all documents from the collection but leaves the indexes intact."
        },
        {
          "info": {
            "name": "Update collection properties",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-play.paas.macrometa.io/_fabric/:fabric/_api/collection/:collection-name/properties",
            "params": [
              {
                "name": "fabric",
                "value": "",
                "type": "path",
                "description": "The name of the fabric."
              },
              {
                "name": "collection-name",
                "value": "",
                "type": "path",
                "description": "The name of the collection."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the properties of a collection."
        }
      ]
    }
  ],
  "bundled": true
}