{"info":{"_postman_id":"27e81065-8f3d-47ab-bec1-552183f8f34e","name":"Bold Orange Data Lake Documentation","description":"

About the Bold Orange Data Lake

The Bold Orange Data Lake is a highly scalable, central repository, used to store any structured or unstructured raw data. The data can then be used in downstream processes for anything from dashboards and visualizations for reporting to big data processing and machine learning.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8464438","collectionId":"27e81065-8f3d-47ab-bec1-552183f8f34e","publishedId":"TW6wJoUu","public":true,"customColor":{"top-bar":"193853","right-sidebar":"193853","highlight":"EF5B25"},"publishDate":"2022-04-04T20:28:38.000Z"},"item":[{"name":"Authentication","event":[{"listen":"test","script":{"id":"1180161d-44af-4eda-bd94-e0fb5e710087","exec":[""],"type":"text/javascript"}}],"id":"d8c13d3d-27ff-46f0-8fde-fdf64d0755a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Grant\": \"password\",\t\r\n \"Username\": \"yourusername\",\r\n \"Password\": \"yourpassword\"\r\n}"},"url":"https://datalake.boldorange.com/api/v1/authenticate","description":"

Authenticate a user

This method will authenticate a user and return a token to be used for all data lake requests.

Request Attributes

Grant - The grant type.
- Accepted Values: The only current accepted value is \"password\".
\n
Username - Your username.
Password - Your password.

Response Attributes

AccessToken - The access token that is to be used in the authorization header of all data lake requests
RefreshToken - The refresh token (not currently implemented)
TokenType - The type of token
ExpiresIn - The number of seconds until the token expires and needs to be refreshed.
- Currently the only way to get a new token is by re-authenticating after the token expires.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","authenticate"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"36be48b7-4ef4-44f1-8f66-82e8f918cee3","name":"Authentication Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Grant\": \"password\",\t\r\n \"Username\": \"yourusername\",\r\n \"Password\": \"yourpassword\"\r\n}"},"url":"https://datalake.boldorange.com/api/v1/authenticate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:50:45 GMT"},{"key":"Content-Length","value":"274"}],"cookie":[],"responseTime":null,"body":"{\n \"accesstoken\": \"xxx\",\n \"refreshtoken\": \"xxx\",\n \"tokentype\": \"Bearer\",\n \"expiresin\": 2029\n}"}],"_postman_id":"d8c13d3d-27ff-46f0-8fde-fdf64d0755a0"},{"name":"Add Item","event":[{"listen":"test","script":{"id":"a6a779cf-d06b-4132-8e5f-873205cec387","exec":[""],"type":"text/javascript"}}],"id":"14cc0158-b3aa-4395-ad27-4ffa3fd090e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"Key\": \"test123\",\r\n\t\"Attributes\": [{\r\n\t\t\"Name\": \"FirstName\",\r\n\t\t\"Type\": \"string\",\r\n\t\t\"Value\": \"Billford\"\r\n\t}, {\r\n\t\t\"Name\": \"LastName\",\r\n\t\t\"Type\": \"string\",\r\n\t\t\"Value\": \"Barker\"\r\n\t}, {\r\n\t\t\"Name\": \"TestNumber\",\r\n\t\t\"Type\": \"number\",\r\n\t\t\"Value\": \"3.50\"\r\n\t}]\r\n}"},"url":"https://datalake.boldorange.com/api/v1/additem","description":"

Add or update a single item in a collection

This method will either add or update a single item in a collection. If the item exists based on the provided key value, it is updated, otherwise the item is added.

Request Attributes

CollectionName - The name of the collection to add the item to. If the collection does not exist, it will be created.
- Accepted Values: CollectionName may only contain the characters a-z, A-Z, or 0-9 and must also start with a capital letter.
\n
Optional: Key - The primary or unique key of the item you are adding. This can later be used to update the item.
Optional: AutoKey - Boolean field indicating if you would like to automatically generate a key in the event that one is not available. The generated key is a composite hash value of all attribute values provided.
Optional: AutoKeyAttributes - A list of attributes to include in the AutoKey generation process. Only values from attributes in this list will be used for the composite hash value.
Attributes - A collection of attributes associated with the item
- Name - The name of the attribute
  - Accepted Values: Name may only contain the characters _, a-z, A-Z, and 0-9
  \n
- Value - The value of the attribute in string format.
- Type - The type of attribute
  - Accepted Values: \"string\", \"number\", \"date\", or \"bool\"
  \n
\n

Response Attributes

Success - True/False upon item creation success.
ItemStatus - Indicator of the item status, whether added, changed, or unchanged.
Key - If using AutoKey, the Key of the item created or updated will be returned.

\n","urlObject":{"protocol":"https","path":["api","v1","additem"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"e13732c9-9c80-434d-970d-746b568575f9","name":"Add Item Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"Key\": \"test123\",\r\n\t\"Attributes\": [{\r\n\t\t\"Name\": \"FirstName\",\r\n\t\t\"Type\": \"string\",\r\n\t\t\"Value\": \"Billford\"\r\n\t}, {\r\n\t\t\"Name\": \"LastName\",\r\n\t\t\"Type\": \"string\",\r\n\t\t\"Value\": \"Barker\"\r\n\t}, {\r\n\t\t\"Name\": \"TestNumber\",\r\n\t\t\"Type\": \"number\",\r\n\t\t\"Value\": \"3.50\"\r\n\t}]\r\n}"},"url":"https://datalake.boldorange.com/api/v1/additem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:53:50 GMT"},{"key":"Content-Length","value":"41"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ItemStatus\": \"Unchanged\"\n}"},{"id":"de15b875-39f0-4d54-a02e-efded9a0c8e6","name":"Add Item Example Using AutoKey","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"AutoKey\":true,\r\n \"AutoKeyAttributes\": [\"FirstName\"],\r\n\t\"Attributes\": [{\r\n\t\t\"Name\": \"FirstName\",\r\n\t\t\"Type\": \"string\",\r\n\t\t\"Value\": \"Billford\"\r\n\t}, {\r\n\t\t\"Name\": \"LastName\",\r\n\t\t\"Type\": \"string\",\r\n\t\t\"Value\": \"Barker\"\r\n\t}, {\r\n\t\t\"Name\": \"TestNumber\",\r\n\t\t\"Type\": \"number\",\r\n\t\t\"Value\": \"3.50\"\r\n\t}]\r\n}"},"url":"https://datalake.boldorange.com/api/v1/additem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:53:50 GMT"},{"key":"Content-Length","value":"41"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ItemStatus\": \"Unchanged\",\n \"Key\": \"DCB33DCDA710EEAE711B3E26AF1BDE444EA024222225AC339FC939CBB009BABCA732B1C0D4110EC15E7254032B0A556E916E721F7B30A33A5D2948D3AA1880A8\"\n}"}],"_postman_id":"14cc0158-b3aa-4395-ad27-4ffa3fd090e9"},{"name":"Add Items","event":[{"listen":"test","script":{"id":"dc685b5a-a919-495b-a45d-69c975e7040c","exec":[""],"type":"text/javascript"}}],"id":"d12622a5-74ab-4328-a9aa-feb170b0d312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CollectionName\": \"TestItems\",\n \"Items\": [\n {\n \"Key\": \"mytest\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Fat\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Cat\"\n }\n ]\n },\n {\n \"Key\": \"mytest2\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Good Boi\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Dog\"\n }\n ]\n },\n {\n \"Key\": \"mytest3\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Tall\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Giraffe\"\n }\n ]\n }\n ]\n}"},"url":"https://datalake.boldorange.com/api/v1/additems","description":"

Add or update a multiple items in a collection

This method will either add or update a multiple items in a collection. If the item exists based on the provided key value, it is updated, otherwise the item is added.

Request Attributes

CollectionName - The name of the collection to add the item to. If the collection does not exist, it will be created.
- Accepted Values: CollectionName may only contain the characters a-z, A-Z, or 0-9 and must also start with a capital letter.
\n
Optional: AutoKey - Boolean field indicating if you would like to automatically generate a key for each item in the event that one is not available. The generated key is a composite hash value of all attribute values provided.
Optional: AutoKeyAttributes - A list of attributes to include in the AutoKey generation process. Only values from attributes in this list will be used for the composite hash value.
Items - The items to be added or updated. Note: The number of items in a request cannot exceed 100 and the max size of a request cannot exceed 10 MB.
- Optional: Key - The primary or unique key of the item you are adding. This can later be used to update the item. Cannot be used in combination with AutoKey.
- Attributes - A collection of attributes associated with the item
  - Name - The name of the attribute
    - Accepted Values: Name may only contain the characters _, a-z, A-Z, and 0-9
    \n
  - Value - The value of the attribute in string format.
  - Type - The type of attribute
    - Accepted Values: \"string\", \"number\", \"date\", or \"bool\"
    \n
  \n
\n

Response Attributes

ItemsReceived - The total number of items received for processing
ItemsAdded - The total number of items added
ItemsUpdated - The total number of items updated
ItemsUnchanged - The total number of unchanged items
ItemsWithErrors - The total number of items with errors

\n","urlObject":{"protocol":"https","path":["api","v1","additems"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"773e2480-4201-4eb2-a3a9-08da1700eafa","name":"Add Items Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CollectionName\": \"TestItems\",\n \"Items\": [\n {\n \"Key\": \"mytest\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Fat\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Cat\"\n }\n ]\n },\n {\n \"Key\": \"mytest2\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Good Boi\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Dog\"\n }\n ]\n },\n {\n \"Key\": \"mytest3\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Tall\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Giraffe\"\n }\n ]\n }\n ]\n}"},"url":"https://datalake.boldorange.com/api/v1/additems"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:54:06 GMT"},{"key":"Content-Length","value":"90"}],"cookie":[],"responseTime":null,"body":"{\n \"ItemsReceived\": 3,\n \"ItemsAdded\": 0,\n \"ItemsUpdated\": 0,\n \"ItemsUnchanged\": 3,\n \"ItemsWithErrors\": 0\n}"},{"id":"e9a381df-8540-4b5e-a7b5-b9cc0d11cc41","name":"Add Items Example Using AutoKey","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CollectionName\": \"TestItems\",\n \"AutoKey\":true,\n \"AutoKeyAttributes\": [\"FirstName\"],\n \"Items\": [\n {\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Fat\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Cat\"\n }\n ]\n },\n {\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Good Boi\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Dog\"\n }\n ]\n },\n {\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Tall\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Giraffe\"\n }\n ]\n },\n {\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Tall\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Giraffe\"\n }\n ]\n }\n ]\n}"},"url":"https://datalake.boldorange.com/api/v1/additems"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:54:06 GMT"},{"key":"Content-Length","value":"90"}],"cookie":[],"responseTime":null,"body":"{\n \"ItemsReceived\": 3,\n \"ItemsAdded\": 0,\n \"ItemsUpdated\": 0,\n \"ItemsUnchanged\": 3,\n \"ItemsWithErrors\": 0\n}"}],"_postman_id":"d12622a5-74ab-4328-a9aa-feb170b0d312"},{"name":"Get Item","event":[{"listen":"test","script":{"id":"7900be36-c7dd-4399-ad6b-69d361c67ace","exec":[""],"type":"text/javascript"}}],"id":"c025831f-2f7f-4744-a2b2-0b5cba5e52c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"Attributes\": [\"FirstName\", \"LastName\"],\r\n\t\"Key\":\"test123\"\r\n}"},"url":"https://datalake.boldorange.com/api/v1/getitem","description":"

Get an item in a collection

This method will get an item in a collection by key

Request Attributes

CollectionName - The name of the collection to get the items from
Attributes - A collection of attributes of an item to be returned.
Key - The key of the item to get

Response Attributes

ItemFound- A boolean indicating if the item exists
Item - The item found
- Key - The key of the item, if set.
- Partition - The internal data lake partition of the item.
- Sort - The internal data lake sort key of the item
- CreateDate - The create date of the item
- ModifyDate - The modify date of the item
- Attributes - The collection of attributes for the item as specified in the request
  - Name - The name of the attribute
  - Value - The value of the attribute
  - Type - The type of the attribute
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","v1","getitem"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"7f502e97-cd4f-484c-b537-77089321ef5a","name":"Get Item Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"Attributes\": [\"FirstName\", \"LastName\"],\r\n\t\"Key\":\"test123\"\r\n}"},"url":"https://datalake.boldorange.com/api/v1/getitem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:55:01 GMT"},{"key":"Content-Length","value":"1734"}],"cookie":[],"responseTime":null,"body":"{\n \"ItemFound\": true,\n \"Item\": {\n \"Key\": \"test123\",\n \"Partition\": \"2022:07:29:wMn38L\",\n \"Sort\": \"11:16:25:$%Q#A33XV1fL3BrnQkDWj7Rsn1PAj9U/GZy@xvJ^qaex9aKY4K9p1HX\",\n \"Hash\": \"F4BCAA9B996558FD51F7428E0FF2DE5AACE6911871EB7498D6F2F3180E03642C76FB7C2B096E5F04FA4FBFC778E56D9454B1E89B2996AFABB9F80D315ADE9B30\",\n \"CreateDate\": \"2022-07-29T11:16:25.314-05:00\",\n \"ModifyDate\": \"2022-07-29T11:16:25.314-05:00\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Fat\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Cat\"\n }\n ]\n }\n}"}],"_postman_id":"c025831f-2f7f-4744-a2b2-0b5cba5e52c5"},{"name":"Get Items","event":[{"listen":"test","script":{"id":"7900be36-c7dd-4399-ad6b-69d361c67ace","exec":[""],"type":"text/javascript"}}],"id":"dbb249e7-d563-4993-bd7e-509ac3843032","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"Attributes\": [\"FirstName\", \"LastName\"],\r\n \"Limit\": 5\r\n}"},"url":"https://datalake.boldorange.com/api/v1/getitems","description":"

Get items in a collection

This method will get a page of items from a collection

Request Attributes

CollectionName - The name of the collection to get the items from
Attributes - A collection of attributes of an item to be returned.
Optional: Limit - The number of items to be returned per page. The default limit is 1000 items.
Optional: LastEvaluatedKey - Only return items with a evaluation key after the provided key. Used to get subsequent pages of results.
Optional: StartDate - Only return items with a ModifyDate older than the provided date
Optional: EndDate - Only return items with a ModifyDate newer than the provided date
Optional: Sort - Specify the property to sort by, as well as the sort direction. Example: ModifyDate desc

Response Attributes

LastEvaluatedKey - The evaluation key of the last item in the request. Used to get the next set of items in subsequent requests.
Items - The collection of items returned
- Key - The key of the item, if set.
- Partition - The internal data lake partition of the item.
- Sort - The internal data lake sort key of the item
- CreateDate - The create date of the item
- ModifyDate - The modify date of the item
- Attributes - The collection of attributes for the item as specified in the request
  - Name - The name of the attribute
  - Value - The value of the attribute
  - Type - The type of the attribute
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","v1","getitems"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"2e5abb52-fd0f-4cd9-b11f-3a7146e168c2","name":"Get Items Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n\t\"Attributes\": [\"FirstName\", \"LastName\"],\r\n \"Limit\": 5\r\n}"},"url":"https://datalake.boldorange.com/api/v1/getitems"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:55:01 GMT"},{"key":"Content-Length","value":"1734"}],"cookie":[],"responseTime":null,"body":"{\n \"LastEvaluatedKey\": \"5e32f3bc5851c71df8212586\",\n \"Items\": [\n {\n \"Key\": \"test123\",\n \"Partition\": \"2019:11:19:Eg38Z4\",\n \"Sort\": \"13:55:32:ZS6%#MT$nm%t#gHFP8aZbQpK6T&QfZncPrFq*6#MAYh*b93#aKaCZ5B\",\n \"CreateDate\": \"2019-11-19T13:55:32.549-06:00\",\n \"ModifyDate\": \"2020-12-11T12:48:04.612-06:00\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Billford\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Barker\"\n }\n ]\n },\n {\n \"Key\": \"test123343\",\n \"Partition\": \"2019:11:19:XtaQ5G\",\n \"Sort\": \"14:32:01:g9RxK%r8hEA01Q3dLy%NYPtNx/A3rT#WQ4jVvj^7Apr1wapeaJE03D9\",\n \"CreateDate\": \"2019-11-19T14:32:01.325-06:00\",\n \"ModifyDate\": \"2019-11-19T14:32:01.324-06:00\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Bill\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Barker\"\n }\n ]\n },\n {\n \"Key\": \"mytest\",\n \"Partition\": \"2019:11:19:Eg38Z4\",\n \"Sort\": \"21:42:41:E7WSm&3cZ4gQQdyNS3!2wGq8tV*Sph2f68v513%r$K!GhttNb8rdst/\",\n \"CreateDate\": \"2019-11-19T21:42:41.72-06:00\",\n \"ModifyDate\": \"2020-12-11T12:42:00.668-06:00\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Fat\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Cat\"\n }\n ]\n },\n {\n \"Key\": \"MyKey123\",\n \"Partition\": \"2019:12:05:W9WAjR\",\n \"Sort\": \"11:48:02:Yzt6HqYwYj4TUPjEKx682aB2J%^vC^Ja*gmLE0Xx7!n6uqDUfhuMp0x\",\n \"CreateDate\": \"2019-12-05T11:48:02.3-06:00\",\n \"ModifyDate\": \"2020-12-11T12:48:17.342-06:00\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Sammy\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Sorenfied\"\n }\n ]\n },\n {\n \"Key\": \"test123888\",\n \"Partition\": \"2020:01:30:TgW6b6\",\n \"Sort\": \"09:18:20:VL*WbKT*5b7QQkaqbEQbXybe%Qa^Sw5ZfJS2K4e^%aZ1bvE!vDtNEM%\",\n \"CreateDate\": \"2020-01-30T09:18:20.428-06:00\",\n \"ModifyDate\": \"2020-01-30T09:22:49.385-06:00\",\n \"Attributes\": [\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"Value\": \"Bill\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"Value\": \"Barker\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"dbb249e7-d563-4993-bd7e-509ac3843032"},{"name":"Get Collections","event":[{"listen":"test","script":{"id":"cde3a085-cdf9-44ad-90e2-2e8cd76a291d","exec":[""],"type":"text/javascript"}}],"id":"990d4232-f686-4a66-a1c9-fc6b85cfd22b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://datalake.boldorange.com/api/v1/getcollections","description":"

Get the details of a collection

This method will get all of the collections that the current user has access to view.

No Request Attributes

Response Attributes

CollectionNames - A collection of names that the current user has access to view.

\n","urlObject":{"protocol":"https","path":["api","v1","getcollections"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"4a26d1ae-dd93-4b1e-a1e1-e2b20d9deee4","name":"Get Collections Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://datalake.boldorange.com/api/v1/getcollections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 28 Jan 2021 16:10:22 GMT"},{"key":"Content-Length","value":"2"}],"cookie":[],"responseTime":null,"body":"[\r\n \"TestDataCollection1\",\r\n \"TestDataCollection2\"\r\n]"}],"_postman_id":"990d4232-f686-4a66-a1c9-fc6b85cfd22b"},{"name":"Get Collection Details","event":[{"listen":"test","script":{"id":"b608663f-bf58-42d4-b9bd-a9af07847a20","exec":[""],"type":"text/javascript"}}],"id":"d66ae00b-4da7-4751-896a-c0a6affe48f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\",\r\n \"SampleCount\": 100\r\n}"},"url":"https://datalake.boldorange.com/api/v1/getcollectiondetails","description":"

Get the details of a collection

This method will get a page of items from a collection

Request Attributes

CollectionName - The name of the collection to get details about
Optional: SampleCount - The number of random documents to be sampled from the collection
- Accepted values range between 0 and 1,000,000. If omitted, 5% of the collection is sampled, resulting insignificant performance increases
\n

Response Attributes

Name - The name of the collection
Size - The size of the collection in bytes
Count - The number of items in the collection
SampleCount - The number of items sampled to produce the response
AvgItemsAddedPerDay - The average number of items added to the collection per day
AvgItemsUpdatedPerDay - The average number of items updated in the collection per day
AvgItemsDeletedPerDay - The average number of items deleted in a collection per day
HealthMessage - A descriptive message indicating collection health
HealthStatus - A health status field indicating collection health.
Fields - A collection of fields that represent the collection
- Name - The name of the fields. Fields with underscores (_) in them are system fields
- Type - The data lake type of the fields
- DBType - An estimated field type that would be used in an SQL database to hold the data
\n

\n","urlObject":{"protocol":"https","path":["api","v1","getcollectiondetails"],"host":["datalake","boldorange","com"],"query":[],"variable":[]}},"response":[{"id":"008eaca9-5b1b-4567-aa48-dc28ad987ee4","name":"Get Collection Details Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {accesstoken}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CollectionName\": \"TestItems\"\r\n}"},"url":"https://datalake.boldorange.com/api/v1/getcollectiondetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 27 Jan 2021 15:55:12 GMT"},{"key":"Content-Length","value":"2229"}],"cookie":[],"responseTime":null,"body":"{\n \"Name\": \"TestItems\",\n \"Size\": 10729,\n \"Count\": 22,\n \"SampleCount\": 22,\n \"AvgItemsAddedPerDay\": 0,\n \"AvgItemsUpdatedPerDay\": 0,\n \"AvgItemsDeletedPerDay\": 0,\n \"HealthMessage\": \"Not Monitored\",\n \"HealthStatus\": \"gray\",\n \"Fields\": [\n {\n \"Name\": \"_CreateDate\",\n \"Type\": \"date\",\n \"DBType\": \"TIMESTAMP\"\n },\n {\n \"Name\": \"_Hash\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(1000)\"\n },\n {\n \"Name\": \"_id\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(255)\"\n },\n {\n \"Name\": \"_Key\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(100)\"\n },\n {\n \"Name\": \"_ModifyDate\",\n \"Type\": \"date\",\n \"DBType\": \"TIMESTAMP\"\n },\n {\n \"Name\": \"_ModifyKey\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(255)\"\n },\n {\n \"Name\": \"_Partition\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(100)\"\n },\n {\n \"Name\": \"_Sort\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(500)\"\n },\n {\n \"Name\": \"FirstName\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(100)\"\n },\n {\n \"Name\": \"LastName\",\n \"Type\": \"string\",\n \"DBType\": \"VARCHAR(100)\"\n },\n {\n \"Name\": \"TestArray\"\n },\n {\n \"Name\": \"TestNumber\",\n \"Type\": \"number\",\n \"DBType\": \"FLOAT\"\n }\n ]\n}"}],"_postman_id":"d66ae00b-4da7-4751-896a-c0a6affe48f1"}],"event":[{"listen":"prerequest","script":{"id":"236dd826-9a74-4f56-88b2-44e484a0e823","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"08bea856-f39e-466b-8230-84e97cc1dbaf","type":"text/javascript","exec":[""]}}]}