{
  "opencollection": "1.0.0",
  "info": {
    "name": "Select Star Metadata bi documents API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "documents_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/documents/",
            "params": [
              {
                "name": "collections",
                "value": "",
                "type": "query",
                "description": "A comma separated list of collection guids, for to filter the collection items from"
              },
              {
                "name": "doc_type",
                "value": "",
                "type": "query",
                "description": "A comma separated list of document types to filter for.\n\nNote: `document` type is used for \"Page\" documents."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive."
              },
              {
                "name": "owners",
                "value": "",
                "type": "query",
                "description": "A comma separated list of user or team guids to filter for objects within these users as owners (technical or business)."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "search_business_owner",
                "value": "",
                "type": "query",
                "description": "Search for an asset using business owner name"
              },
              {
                "name": "search_collections",
                "value": "",
                "type": "query",
                "description": "Search for an asset using a collection name"
              },
              {
                "name": "search_description",
                "value": "",
                "type": "query",
                "description": "A search term."
              },
              {
                "name": "search_name",
                "value": "",
                "type": "query",
                "description": "Search for an asset using its name"
              },
              {
                "name": "search_tag_name",
                "value": "",
                "type": "query",
                "description": "Search for an asset using a tag name"
              },
              {
                "name": "search_technical_owner",
                "value": "",
                "type": "query",
                "description": "Search for an asset using technical owner name"
              },
              {
                "name": "teams",
                "value": "",
                "type": "query",
                "description": "A comma separated list of team guids to filter for tables owned by users of those teams."
              },
              {
                "name": "updated_on",
                "value": "",
                "type": "query",
                "description": "Filter objects by updated_on. May specify __gt, __gte, __lt or __lte.\n\n API call to: \n\n ENDPOINT/updated_on__gt=2021-08-04T15:12:40&updated_on__lt=2021-08-23 \n\n will result with objects updated_on after  August 4th 2021 at 15:12:40, but before August 23rd 2021. \n\n. If you want to include lower or upper bound of the range use __gte or __lte respectively."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "lists documents\n\n**Required Role:** Viewer or higher"
        },
        {
          "info": {
            "name": "documents_create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/documents/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "creates a new document object\n\n**Required Role:** Data Manager or higher"
        },
        {
          "info": {
            "name": "documents_bulk_delete",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/documents/",
            "params": [
              {
                "name": "collections",
                "value": "",
                "type": "query",
                "description": "A comma separated list of collection guids, for to filter the collection items from"
              },
              {
                "name": "doc_type",
                "value": "",
                "type": "query",
                "description": "A comma separated list of document types to filter for.\n\nNote: `document` type is used for \"Page\" documents."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive."
              },
              {
                "name": "owners",
                "value": "",
                "type": "query",
                "description": "A comma separated list of user or team guids to filter for objects within these users as owners (technical or business)."
              },
              {
                "name": "search_business_owner",
                "value": "",
                "type": "query",
                "description": "Search for an asset using business owner name"
              },
              {
                "name": "search_collections",
                "value": "",
                "type": "query",
                "description": "Search for an asset using a collection name"
              },
              {
                "name": "search_description",
                "value": "",
                "type": "query",
                "description": "A search term."
              },
              {
                "name": "search_name",
                "value": "",
                "type": "query",
                "description": "Search for an asset using its name"
              },
              {
                "name": "search_tag_name",
                "value": "",
                "type": "query",
                "description": "Search for an asset using a tag name"
              },
              {
                "name": "search_technical_owner",
                "value": "",
                "type": "query",
                "description": "Search for an asset using technical owner name"
              },
              {
                "name": "teams",
                "value": "",
                "type": "query",
                "description": "A comma separated list of team guids to filter for tables owned by users of those teams."
              },
              {
                "name": "updated_on",
                "value": "",
                "type": "query",
                "description": "Filter objects by updated_on. May specify __gt, __gte, __lt or __lte.\n\n API call to: \n\n ENDPOINT/updated_on__gt=2021-08-04T15:12:40&updated_on__lt=2021-08-23 \n\n will result with objects updated_on after  August 4th 2021 at 15:12:40, but before August 23rd 2021. \n\n. If you want to include lower or upper bound of the range use __gte or __lte respectively."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "deletes multiple documents\n\n**Required Role:** Data Manager or higher"
        },
        {
          "info": {
            "name": "documents_retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/documents/:guid/",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "gets a document object\n\n**Required Role:** Viewer or higher"
        },
        {
          "info": {
            "name": "documents_partial_update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/documents/:guid/",
            "params": [
              {
                "name": "guid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "updates a document object\n\n**Required Role:** Data Manager or higher"
        },
        {
          "info": {
            "name": "documents_destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/documents/:guid/",
            "params": [
              {
                "name": "collections",
                "value": "",
                "type": "query",
                "description": "A comma separated list of collection guids, for to filter the collection items from"
              },
              {
                "name": "doc_type",
                "value": "",
                "type": "query",
                "description": "A comma separated list of document types to filter for.\n\nNote: `document` type is used for \"Page\" documents."
              },
              {
                "name": "guid",
                "value": "",
                "type": "path"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive."
              },
              {
                "name": "owners",
                "value": "",
                "type": "query",
                "description": "A comma separated list of user or team guids to filter for objects within these users as owners (technical or business)."
              },
              {
                "name": "search_business_owner",
                "value": "",
                "type": "query",
                "description": "Search for an asset using business owner name"
              },
              {
                "name": "search_collections",
                "value": "",
                "type": "query",
                "description": "Search for an asset using a collection name"
              },
              {
                "name": "search_description",
                "value": "",
                "type": "query",
                "description": "A search term."
              },
              {
                "name": "search_name",
                "value": "",
                "type": "query",
                "description": "Search for an asset using its name"
              },
              {
                "name": "search_tag_name",
                "value": "",
                "type": "query",
                "description": "Search for an asset using a tag name"
              },
              {
                "name": "search_technical_owner",
                "value": "",
                "type": "query",
                "description": "Search for an asset using technical owner name"
              },
              {
                "name": "teams",
                "value": "",
                "type": "query",
                "description": "A comma separated list of team guids to filter for tables owned by users of those teams."
              },
              {
                "name": "updated_on",
                "value": "",
                "type": "query",
                "description": "Filter objects by updated_on. May specify __gt, __gte, __lt or __lte.\n\n API call to: \n\n ENDPOINT/updated_on__gt=2021-08-04T15:12:40&updated_on__lt=2021-08-23 \n\n will result with objects updated_on after  August 4th 2021 at 15:12:40, but before August 23rd 2021. \n\n. If you want to include lower or upper bound of the range use __gte or __lte respectively."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "deletes a document object\n\n**Required Role:** Data Manager or higher"
        },
        {
          "info": {
            "name": "documents_owners_partial_update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/documents/owners/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "API endpoints documents.\n\n**Required Role:** Data Manager or higher"
        }
      ]
    }
  ],
  "bundled": true
}