{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"minLevel":{"value":"2"},"type":{"value":"flat"}},"macroMetadata":{"macroId":{"value":"58ed7e73-a1ea-4e13-8572-a6bf68e20b3c"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"6c258eac-c2d0-4fb4-be37-a3afc569cb97"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the list of available endpoints and methods in the Lookups API:","type":"text"}]},{"type":"table","attrs":{"layout":"center","isNumberColumnEnabled":true,"width":747.0,"localId":"1223c80c-e77f-443a-8ce4-8eaf6c045c86"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Endpoints and methods","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"bc34c392-fc87-4c18-aa03-df806743a425"}},{"text":"/lookup/{domain}","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path1"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Display information on the lookups existing on a given domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"0a595ce5-7d9c-4433-af61-3117ceb6ca36"}},{"text":"/lookup/{domain}/{name}","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path2"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Return information of a specific lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"7d332d40-133f-42b3-b50e-c8cb37cb1ccf"}},{"text":"/lookup/{domain}/{name}/job","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path3"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Query the job UUIDs of a specific lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"ec84c202-17e7-480c-86e5-955a0dc052c1"}},{"text":" ","type":"text"},{"text":"/lookup/{domain}/{name}/job/{id}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path4"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Query the statuses of a lookup job.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Advanced mode","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"0f4126c7-c1d6-4e34-b6b9-10c92507c1ab"}},{"text":"lookup/{domain}/{name}/deploy-config","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path5"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Advanced mode","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Create a new lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"f0b19c3c-2b66-4d5e-8660-6310411b7d0f"}},{"text":"lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path6"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Create a new lookup using a CSV (application/json request body)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"f736481b-114f-4494-a6ae-80abb3579e6b"}},{"text":"lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path7"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Create a new lookup using a CSV (multipart/form-data request body)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"efaa912a-8e8a-44dd-bdee-d92fc7a0a9e1"}},{"text":"lookup/{domain}/{name}/deploy-static-query","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path8"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Create a new lookup based on a static query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"fe62fa4a-0aeb-45f3-b433-58603796cf8f"}},{"text":"lookup/{domain}/{name}/deploy-periodic-query","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path9"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Create a new lookup based on a periodic query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"473ee798-17cc-4f92-8406-3ab784372bc3"}},{"text":"lookup/{domain}/{name}/deploy-sliding-window-query","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path10"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Create a new lookup based on a sliding window query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"text":"Advanced mode","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"5975b4fb-6c4b-4e08-969e-33eea35980b2"}},{"text":" ","type":"text"},{"text":"lookup/{domain}/{name}/deploy-config","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path11"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Advanced mode","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Update a specific lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"3cb887f9-1866-471d-849a-8faa68c2ebec"}},{"text":" ","type":"text"},{"text":"lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path12"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Update a CSV lookup (application/json request body)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"ffc4062d-f2a2-4c77-ba81-31a15acd4a12"}},{"text":" ","type":"text"},{"text":"lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path13"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Update a CSV lookup (multipart/form-data request body)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"9dfc1fd2-71e3-492a-bfe4-ec96388a8512"}},{"text":" ","type":"text"},{"text":"lookup/{domain}/{name}/deploy-static-query","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path14"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Update a lookup based on a static query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"687d4844-8a94-4b7a-994c-1f072a1f88d1"}},{"text":" ","type":"text"},{"text":"lookup/{domain}/{name}/deploy-periodic-query","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path15"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Update a lookup based on a periodic query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"9312c931-0ea8-4b4d-85bf-94ab1dfb8cf3"}},{"text":" ","type":"text"},{"text":"lookup/{domain}/{name}/deploy-sliding-window-query","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path16"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Update a lookup based on a sliding window query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[365.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"DELETe","localId":"ca0922c2-8a89-4fc4-9ba5-ff4921872c31"}},{"text":"/lookup/{domain}/{name}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path17"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Send a request to delete a specific lookup.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Endpoints and methods","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path1"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path1"}},"macroMetadata":{"macroId":{"value":"8d6a668df3f46910157aebb23d754198"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"836e06f2-97d8-4af9-9c65-5e7ea5dae5c2"}},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/lookup/{domain}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Display information on the lookups existing on a given domain.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":660.0,"localId":"51a30e57-b4ab-4df9-8e1b-cec8129f6d5d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[313.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"Type ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[573.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[313.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[179.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[573.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain that contains the lookups you want to list.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Query string parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Query string parameters are optionally added after the path parameters, preceded by a question mark (","type":"text"},{"text":"?","type":"text","marks":[{"type":"code"}]},{"text":") and separated by an ampersand (","type":"text"},{"text":"&","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"7358f075-1657-4323-b43c-e5f049c6dac3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[303.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[182.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[303.0]},"content":[{"type":"paragraph","content":[{"text":"max_length","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[182.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Maximum number of values to return. The default value is ","type":"text"},{"text":"100","type":"text","marks":[{"type":"code"}]},{"text":". The maximum value is ","type":"text"},{"text":"1000","type":"text","marks":[{"type":"code"}]},{"text":" and the minimum value is ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Lookups are shown from oldest to newest.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[303.0]},"content":[{"type":"paragraph","content":[{"text":"pageToken","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[182.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Use this parameter to consider a previously requested list on your next request. This should be set to the value shown in the ","type":"text"},{"text":"nextPageToken","type":"text","marks":[{"type":"code"}]},{"text":" parameter included in the response you want to consider, if successful.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, you may perform a request and ask for information about the oldest 5 lookups in your domain. Then, you can perform a second request including the value in the ","type":"text"},{"text":"nextPageToken","type":"text","marks":[{"type":"code"}]},{"text":" parameter returned with the previous response and requesting only 2 lookups. This will return the 2 lookups created after the first 5 previously requested.","type":"text"}]},{"type":"paragraph","content":[{"text":"The default and minimum value is ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[303.0]},"content":[{"type":"paragraph","content":[{"text":"owner","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[182.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"You can filter the lookups in the response based on their domain owner, that is, the domain where the lookup was created. Supported values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"THIS_DOMAIN","type":"text","marks":[{"type":"code"}]},{"text":" - Returns only lookups created in the domain indicated in the request URL.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OTHER_DOMAINS","type":"text","marks":[{"type":"code"}]},{"text":" - Returns only lookups owned by other domains but visible by the domain indicated in the request URL. This might be the case of domains that belong to a ","type":"text"},{"text":"multitenant structure","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/144474118"}}]},{"text":" and have access to lookups defined in other domains that belong to that structure. You can decide the visibility level of a new lookup upon its creation.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ANY_DOMAIN","type":"text","marks":[{"type":"code"}]},{"text":" - Returns both lookups owned by the domain indicated in the request URL and those visible by them in other domains.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The default value is ","type":"text"},{"text":"THIS_DOMAIN","type":"text","marks":[{"type":"code"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can decide to make a lookup visible in all the domains within the structure when you create it using ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-config","type":"text","marks":[{"type":"code"}]},{"text":". See how to do it ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text"}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"Find below a request example in cURL language. This request will return information about the 10 oldest lookups created in the domain indicated. Learn how to authorize your request ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/127500308"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -H \"standAloneToken:YOUR_TOKEN\" -X GET https://api-us.devo.com/lookup-api/lookup/myDomain?max_length=10","type":"text"}]},{"type":"paragraph","content":[{"text":"And this request will return information about all the lookups owned by the user domain and also the ones visible to them in other domains:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -H \"standAloneToken:YOUR_TOKEN\" -X GET https://api-us.devo.com/lookup-api/lookup/myDomain?owner=ANY_DOMAIN","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"fafad0fd-981a-4b08-88f2-71e83bb28fa5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[807.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[807.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. The response includes the list of lookups in the given domain with their details.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoListResponse\",\n \"cid\": \"72078e04ee84\",\n \"code\": 200,\n \"context\": null,\n \"id\": \"xxxxxxxxxx-0f74-11ee-b13b-4fc634871e5f\",\n \"msg\": \"tutorial lookups.\",\n \"lookups\": [\n {\n \"name\": \"Lookup_test_t\",\n \"domain\": \"tutorial\",\n \"fileSize\": 12288,\n \"numEntries\": 136,\n \"creationDate\": \"2023-03-15T13:45:57.63\",\n \"keyType\": {\n \"type\": \"first\",\n \"columns\": null,\n \"hasher\": null\n },\n \"deployConfig\": null,\n \"lastStatus\": null,\n \"fields\": [\n {\n \"column\": \"domain\",\n \"type\": \"str\",\n \"key\": true\n },\n {\n \"column\": \"CDNProvider\",\n \"type\": \"str\",\n \"key\": false\n }\n ],\n \"owner\": \"user@devo.com\"\n },\n {\n \"name\": \"CDN_Providers\",\n \"domain\": \"tutorial\",\n \"fileSize\": 12288,\n \"numEntries\": 136,\n \"creationDate\": \"2023-03-15T13:45:57.806\",\n \"keyType\": {\n \"type\": \"first\",\n \"columns\": null,\n \"hasher\": null\n },\n \"deployConfig\": null,\n \"lastStatus\": null,\n \"fields\": [\n {\n \"column\": \"domain\",\n \"type\": \"str\",\n \"key\": true\n },\n {\n \"column\": \"CDNProvider\",\n \"type\": \"str\",\n \"key\": false\n }\n ],\n \"shared\": false,\n \"owner\": \"user@devo.com\"\n },\n {\n \"name\": \"test_101\",\n \"domain\": \"tutorial\",\n \"fileSize\": 40960,\n \"numEntries\": 307,\n \"creationDate\": \"2023-03-15T13:45:58.338\",\n \"keyType\": {\n \"type\": \"first\",\n \"columns\": null,\n \"hasher\": null\n },\n \"deployConfig\": null,\n \"lastStatus\": null,\n \"fields\": [\n {\n \"column\": \"alertName\",\n \"type\": \"str\",\n \"key\": true\n },\n {\n \"column\": \"alertType\",\n \"type\": \"str\",\n \"key\": false\n },\n {\n \"column\": \"alertMitreTactics\",\n \"type\": \"str\",\n \"key\": false\n },\n {\n \"column\": \"alertMitreTechniques\",\n \"type\": \"str\",\n \"key\": false\n },\n {\n \"column\": \"alertPriority\",\n \"type\": \"int4\",\n \"key\": false\n }\n ],\n \"owner\": \"user@devo.com\"\n },\n {\n \"name\": \"d14022023api\",\n \"domain\": \"tutorial\",\n \"fileSize\": 8192,\n \"numEntries\": 1,\n \"creationDate\": \"2023-03-15T13:46:58.05\",\n \"keyType\": {\n \"type\": \"first\",\n \"columns\": null,\n \"hasher\": null\n },\n \"deployConfig\": null,\n \"lastStatus\": null,\n \"fields\": [\n {\n \"column\": \"key\",\n \"type\": \"int4\",\n \"key\": true\n },\n {\n \"column\": \"fbool\",\n \"type\": \"bool\",\n \"key\": false\n }\n ],\n \"owner\": null\n }\n ],\n \"nextPageToken\": -1\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[807.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoResponseError\",\n \"cid\": \"046ead1c8323\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"xxxxxx-4fbb-11ed-859a-f19049cfd717\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[807.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to list the domain's lookups.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[807.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoResponseError\",\n \"cid\": \"e33f677a6981\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"xxxxxx-504c-11ed-859a-99d2d0713c21\",\n \"msg\": \"Not Found\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path2"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path2"}},"macroMetadata":{"macroId":{"value":"bdb986c2-9803-4952-8012-456bc6c303b5"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"d623d2cc-5983-43f6-94ad-a030528ba529"}},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" ","type":"text"},{"text":"/lookup/{domain}/{name}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Return information of a specific lookup.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"2a52a2d8-e689-4765-99fe-992e0412b7e6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[298.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[188.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[579.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[298.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[188.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[579.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain that contains the lookup you want to retrieve.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[298.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[188.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[579.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to get information about.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"Find below a request example in cURL language. This request will return information about the lookup called ","type":"text"},{"text":"myLookup","type":"text","marks":[{"type":"em"}]},{"text":" created in the domain indicated. Learn how to authorize your request ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/127500308"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -H \"standAloneToken:YOUR_TOKEN\" -X GET https://api-us.devo.com/lookup-api/lookup/myDomain/myLookup","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4c4b5569-6a39-443a-970d-2387d95c1662"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[737.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[737.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. The response includes information about the requested lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoResponse\",\n \"cid\": \"3c9bb672512c\",\n \"code\": 200,\n \"context\": null,\n \"id\": \"xxxxxxxxx-0f75-11ee-b13b-636d49ade562\",\n \"msg\": \"tutorial/test_101 meta information.\",\n \"lookupMetaInfo\": {\n \"name\": \"test_101\",\n \"domain\": \"tutorial\",\n \"fileSize\": 40960,\n \"numEntries\": 307,\n \"creationDate\": \"2023-03-15T13:45:58.14\",\n \"keyType\": {\n \"type\": \"first\",\n \"columns\": null,\n \"hasher\": null\n },\n \"deployConfig\": null,\n \"lastStatus\": null,\n \"fields\": [\n {\n \"column\": \"alertName\",\n \"type\": \"str\",\n \"key\": true\n },\n {\n \"column\": \"alertType\",\n \"type\": \"str\",\n \"key\": false\n },\n {\n \"column\": \"alertMitreTactics\",\n \"type\": \"str\",\n \"key\": false\n },\n {\n \"column\": \"alertMitreTechniques\",\n \"type\": \"str\",\n \"key\": false\n },\n {\n \"column\": \"alertPriority\",\n \"type\": \"int4\",\n \"key\": false\n }\n ],\n \"owner\": \"user@devo.com\"\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[737.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoResponseError\",\n \"cid\": \"4b6cdd188a82\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"xxxxxx-5052-11ed-859a-910aa97972a3\",\n \"msg\": \"Unsuccessful response. Bad Request.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[737.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to get information about the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[737.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoResponseError\",\n \"cid\": \"e33f677a6981\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"xxxxxx-504c-11ed-859a-99d2d0713c21\",\n \"msg\": \"Not Found\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path3"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path3"}},"macroMetadata":{"macroId":{"value":"190c2920-49ef-4dcc-97ec-eb7896b0feac"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"c6e32c61-44f8-4fd9-a237-bbd7cf234bae"}},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" ","type":"text"},{"text":"/lookup/{domain}/{name}/job","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Query the job UUIDs (Universally Unique IDentifier) of a specific lookup. A new job is created for each create, update or delete process that is initiated. Each job is identified by a unique ID, or UUID.","type":"text"}]},{"type":"paragraph","content":[{"text":"You will get the last 10 UUIDs for the requested lookup. The list is ordered chronologically being the first job UUID the oldest and the last one the newest.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"d87a1364-4968-4f78-8ccf-1f7e11ae30f2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[436.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[466.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[436.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[466.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain that contains the required lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[436.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[466.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the required lookup.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"Find below a request example in cURL language. This request will return information about the last jobs generated by the lookup called ","type":"text"},{"text":"myLookup","type":"text","marks":[{"type":"em"}]},{"text":" created in the domain indicated. Learn how to authorize your request ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/127500308"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -H \"standAloneToken:YOUR_TOKEN\" -X GET https://api-us.devo.com/lookup-api/lookup/myDomain/myLookup/job","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"02a09f86-31e6-4c36-b771-769ba9761a75"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Returns the job UUIDs of the given lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"cid\": \"e47f4ab72ded\",\n \"code\": 200,\n \"context\": null,\n \"id\": \"xxxxxxxx-e37c-11ed-b5ea-0242ac120002\",\n \"msg\": \"Lookup job uuids\",\n \"jobs\": [\n \"xxxxxxx-c9a2-489c-8794-ea656a19b822\",\n \"xxxxxxx-9714-48a7-9976-73e41523edfd\",\n \"xxxxxxx-48a8-46ea-ab22-e0a5458e302b\",\n \"xxxxxxx-ad7e-4fe6-bb43-89f93e629d76\"\n ]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupMetaInfoResponseError\",\n \"cid\": \"6cde7fd6a1f4\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"xxxxxxx-53a2-11ed-859a-33f9a0bb845a\",\n \"msg\": \"Unsuccessful response. Bad Request.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to access the lookup","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path4"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path4"}},"macroMetadata":{"macroId":{"value":"f349fe32-c83e-445b-9aac-2e32e8283541"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"26dda724-ee4e-4d84-8fc7-d78962998048"}},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" ","type":"text"},{"text":"/lookup/{domain}/{name}/job/{id}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Query the statuses of a lookup job given its UUID. You can get a job UUID using the request explained above.","type":"text"}]},{"type":"paragraph","content":[{"text":"You will get the last 50 statuses for the requested lookup job. The list is ordered chronologically being the first status the oldest and the last one the newest.","type":"text"}]},{"type":"paragraph","content":[{"text":" These are the possible status codes you may get in your response:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e335f310-5cfd-4a51-b111-a6fa26c4326e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Status","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"create.start","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup creation started.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"create.ok","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup successfully created.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"create.err","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Error creating lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"push.start","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup synchronous upload started.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"push.ok","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Successful lookup synchronous upload.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"push.err","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup synchronous upload failed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"deploy.start","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup asynchronous upload started.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"deploy.ok","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Successful lookup asynchronous upload started.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"deploy.err","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup asynchronous upload failed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"del.start","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup deletion started.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"del.ok","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup successfully deleted.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"del.err","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[591.0]},"content":[{"type":"paragraph","content":[{"text":"Error deleting lookup.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"0b4e0d01-3d31-4b73-8cca-43ee2f2195f0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[304.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[304.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain that contains the required lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[304.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the required lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[304.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the UUID of the required lookup job. You can get a job UUID using the request explained above, under the ","type":"text"},{"text":"jobs","type":"text","marks":[{"type":"code"}]},{"text":" parameter in the response.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"Find below a request example in cURL language. This request will return information about the lookup called ","type":"text"},{"text":"myLookup","type":"text","marks":[{"type":"em"}]},{"text":" created in the domain indicated. Learn how to authorize your request ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/127500308"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -H \"standAloneToken:YOUR_TOKEN\" -X GET https://api-us.devo.com/lookup-api/lookup/myDomain/myLookup/job/123456","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"256fcb17-3d0b-4969-8e9e-05ef13d9a894"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[910.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[910.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Returns the job statuses.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"cid\": \"e47f4ab72ded\",\n \"code\": 200,\n \"context\": null,\n \"id\": null,\n \"msg\": \"Lookup job's statuses\",\n \"status\": [\n {\n \"eventdata\": \"2021-09-29T10:18:10.805\",\n \"domain\": \"galactic_empire\",\n \"lookup\": \"ImperialIntranetActivity\",\n \"msg\": \"Lookup successfully created\"\n \"code\": \"create.ok\"\n },\n {\n \"eventdata\": \"2021-09-29T10:18:12.472\",\n \"domain\": \"ImperialIntranetActivity\",\n \"lookup\": \"test-schedule\",\n \"msg\": \"Lookup ready to be executed\"\n \"code\": \"deploy.ok\"\n }\n ]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[910.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupJobsError\",\n \"cid\": \"4d1eb85a908d\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"xxxxxx-53a4-11ed-859a-2d69d242a54f\",\n \"msg\": \"Unsuccessful response. Bad Request.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[155.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[910.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to access the lookup","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path5"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path5"}},"macroMetadata":{"macroId":{"value":"43bf2ca5f6324b75fea7eb7a273a97885185b9ab2d5755f076ae4421a839cbe8"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"06821f22-ab96-411b-b101-b1463a398503"}},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-config","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Create a new lookup.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"308264d8-678f-4303-b674-76271a45cc9e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[281.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[532.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[281.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[532.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the new lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[281.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[252.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[532.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the new lookup.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"recipe","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"notifyStatus","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"id"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-id"}},"macroMetadata":{"macroId":{"value":"6293b96e90c6dfe6c8eab056c8258bc5"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"6c8a25b4-1cba-4e1f-a456-2d8e4299932f"}}]},{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" - Lookup ID object.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"66f57f00-6eb6-4f0f-97fa-afcb6530993c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[257.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"creator","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[257.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"Domain of the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[257.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the lookup.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Example value:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\"id\": {\n \"creator\": \"self\",\n \"name\": \"ForceSensitiveBeings\"\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"visibility"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-visibility"}},"macroMetadata":{"macroId":{"value":"30e9a6dcec58e57fc8f65096ce268c96"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"2d33a5f3-64ce-41ff-9445-10f2ee2939bd"}}]},{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"(string)","type":"text","marks":[{"type":"code"}]},{"text":" Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"recipe"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-recipe"}},"macroMetadata":{"macroId":{"value":"cc9163b0641b04d5cc3e40d642a2a511"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"6bef05ca-f060-4e2e-938f-9ff7d2275cde"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"recipe","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":"- Recipe of the lookup to be created.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6eb95dab-a5f8-48aa-969a-5a3b8d617f2e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"recipeType","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Type of the lookup recipe. Allowed values are ","type":"text"},{"text":"once","type":"text","marks":[{"type":"code"}]},{"text":" (static lookup) and ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":" (periodic lookup). Learn more about lookup types ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/space/latest/95203983/Data+enrichment"}}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"source","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Source data of the lookup to be created. This object states if the lookup will be created using a query (using the ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" field), or through a CSV file stored in AWS S3 (using the ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" field).","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Check more about uploading a lookup using a CSV through S3, see ","type":"text"},{"text":"this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/216825984"}}]},{"text":".","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Array of lookup column descriptors. Only used and required in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty. Each column object may contain the following parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Name of the column.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") 0-based index of the column in the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Data type of the column. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BOOLEAN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"STRING","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TIMESTAMP","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DURATION","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipPreface","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Enter a regular expression to ignore rows of data in a CSV used as source that follow the structure indicated in the regex. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hasHeader","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if the source CSV file has a header row or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipEmptyLines","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if you want to skip empty lines in the source CSV or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Info to get the CSV file from S3.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Name of the S3 bucket where the CSV is located.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Path of the CSV in the bucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transferOwnership","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") - Set this parameter to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" if you want to transfer the CSV ownership to Devo and delete it from the bucket once the lookup is created.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The access key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"secretKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The secret key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket host where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket port where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The AWS region where the S3 bucket has been created.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"lookupType","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Indicate the lookup type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Valid values are ","type":"text"},{"text":"normal","type":"text","marks":[{"type":"code"}]},{"text":" (regular lookups) and ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"time range lookups","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/space/latest/95204060/Create+a+lookup+table+from+a+query#Time-range-lookups"}}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"instantPolicy","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Defines how to calculate the instant of each row. Only used when the generated lookup type is ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":". Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"natural","type":"text","marks":[{"type":"code"}]},{"text":" - The associated source must be historical and the instant of each row will be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"const","type":"text","marks":[{"type":"code"}]},{"text":" - The instance of all rows will be the supplied constant value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The instance will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"timestamp","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"instant","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"number","type":"text","marks":[{"type":"code"}]},{"text":") Only for ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":" lookups of type ","type":"text"},{"text":"const","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columnName","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Only for ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":" lookups of type ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. ","type":"text"}]},{"type":"paragraph","content":[{"text":"However, note that if there is no previous lookup or the recipe is updated (that is to say, the query is modified), this property will be ignored and the lookup will be recreated. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"columnFilter","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"If not null, a white list of columns will be projected. All elements of the list must be defined by the source. Columns whose name is not on this list won't be projected.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"contribution","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Defines how a row contributes to the final result, normally used on incremental lookups.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the contribution policy. Values can be ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"del","type":"text","marks":[{"type":"code"}]},{"text":"or ","type":"text"},{"text":"col","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The contribution will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" and its valid values are ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"secondaryIndexes","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Columns of a lookup indexed as secondary indexes.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the secondary indexes to be applied to the lookup. Values can be ","type":"text"},{"text":"all","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"none","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"by-name","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"none","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"map","type":"text","marks":[{"type":"code"}]},{"text":" - Map of column names to be applied as secondary indexes when the type selected is ","type":"text"},{"text":"by-name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"refreshMillis","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Refresh time of the lookup. Can only be used and is required if the recipe ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" chosen is ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"startMillis","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"Millis since Epoch. Can only be used and is required if the recipe ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" chosen is ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"requiresDate","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[119.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[693.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the source query will be enriched with a closed date range restriction. The lower bound will be the maximum between ","type":"text"},{"text":"startMillis","type":"text","marks":[{"type":"code"}]},{"text":" and the last job instant, and the upper bound will be always ","type":"text"},{"text":"now()","type":"text","marks":[{"type":"code"}]},{"text":". Can only be used if the recipe type chosen is ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"status"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-status"}},"macroMetadata":{"macroId":{"value":"3987fd0ef40dd1ceaad0acd60ad9ee8f"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"827045ba-7ca6-4347-8f0b-a3eb354d74eb"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"notifyStatus","type":"text","marks":[{"type":"code"}]},{"text":"- (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", a notification will be sent to the Devo app once the lookup is executed. If you do not include this parameter, it will be ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":" by default.","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"TotallyNotFakeData\"\n },\n \"recipe\": {\n \"recipeType\": \"once\",\n \"source\": {\n \"query\": \"select 0 as key, false as IsDataFake, 2147483647 as RebelsImprisoned, 9223372036854775807 as CreditsOnImperialBanks, hex4('fffffff') as Hex4Emperor, hex8('fffffffffffffff') as Hex8Vader, 2.718281828459045 as EmperorClones, 3.141592653589793 as Pi, 87.219.9.157 as EmperorIP4, ip6('fe80::4492:bc4b:7a53:c0d5') as EmperorIP6, 0m as TimeAfterBattleOfYavin from siem.logtrust.web.navigation where now()-1m < eventdate < now() limit 1\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": false,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": [\n \"key\",\n \"IsDataFake\",\n \"RebelsImprisoned\",\n \"CreditsOnImperialBanks\",\n \"Hex4Emperor\",\n \"Hex8Vader\",\n \"EmperorClones\",\n \"Pi\",\n \"EmperorIP4\",\n \"EmperorIP6\",\n \"TimeAfterBattleOfYavin\"\n ],\n \"contribution\": {\n \"type\": \"add\"\n },\n \"requiresDate\": false\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d9716f76-7815-41b9-9cb5-2a59d5334c47"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the creation request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d41c91a21d56\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"xxxxxx-2201-11ec-b04a-53c6289921cb\",\n \"msg\": \"Lookup sent to creation\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": \"creator-only\",\n \"recipe\": {\n \"type\": \"once\",\n \"source\": {\n \"query\": \"select eventdate, level, domain, userid, sessionid, correlationId from siem.logtrust.web.activity where now()-1m < eventdate < now()\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": false,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": [\n \"eventdate\",\n \"level\",\n \"domain\",\n \"userid\",\n \"sessionid\",\n \"correlationId\"\n ],\n \"contribution\": {\n \"type\": \"add\"\n }\n }\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": \"BAD_REQUEST\",\n \"id\": \"xxxxxx-5151-11ed-859a-5d2974203ed5\",\n \"message\": \"Bad Request\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to create a lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[173.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[892.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. User credentials are correct but does not have permission to create this lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"9a3eda1848d1\",\n \"code\": 403,\n \"context\": \"FORBIDDEN\",\n \"id\": \"xxxxxx5055-11ed-859a-7b524e50491a\",\n \"msg\": \"User is not authorized to perform operations in the domain.\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path6"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path6"}},"macroMetadata":{"macroId":{"value":"d4ec2cc320a7c0082ed72802a732f26a36d2f2ed72ea04a2cd96a2e94da8aae6"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"7e383d62-c15e-47f8-a029-ba38a1550748"}},{"text":" POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Simplified endpoint to create a new lookup from a CSV file (application/json request body).","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"2b95ec3a-0d56-457c-af72-4bff58d2e9ea"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[372.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[198.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[372.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[198.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[372.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[198.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ecc57329-cbd1-4120-aaf2-453ff4c290b2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Array of lookup column descriptors. Each column object may contain the following parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Name of the column.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") 0-based index of the column in the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Data type of the column. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BOOLEAN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"STRING","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TIMESTAMP","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DURATION","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Info to get the CSV file from S3.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Name of the S3 bucket where the CSV is located.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Path of the CSV in the bucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transferOwnership","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") - Set this parameter to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" if you want to transfer the CSV ownership to Devo and delete it from the bucket once the lookup is created.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The access key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"secretKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The secret key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket host where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket port where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The AWS region where the S3 bucket has been created.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"skipPreface","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Enter a regular expression to ignore rows of data in a CSV used as source that follow the structure indicated in the regex. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"hasHeader","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Indicate if the source CSV file has a header row or not. Only used in CSV sources with fileProvider parameter informed and query parameter empty. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"skipEmptyLines","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Indicate if you want to skip empty lines in the source CSV or not. Only used in CSV sources with fileProvider parameter informed and query parameter empty. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"contribution","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"Defines how a row contributes to the final result, normally used on incremental lookups.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the contribution policy. Values can be ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"del","type":"text","marks":[{"type":"code"}]},{"text":"or ","type":"text"},{"text":"col","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The contribution will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" and its valid values are ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[697.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"columns\": [\n {\n \"name\": \"ID\",\n \"type\": \"INT8\"\n },\n {\n \"name\": \"Location\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"Age\",\n \"type\": \"FLOAT8\"\n },\n {\n \"name\": \"Species\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"MidiclorianLevel\",\n \"type\": \"FLOAT4\"\n }\n ],\n \"key\": {\n \"type\": \"column\",\n \"column\": \"ID\"\n },\n \"fileProvider\": {\n \"bucketName\": \"holocrons-bucket\",\n \"keyName\": \"secrets/data/force-sensitive-beings.csv\",\n \"transferOwnership\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6f52bc17-aa87-44ac-ad92-cdd48130e083"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"columns\": [\n {\n \"name\": \"ID\",\n \"type\": \"INT8\"\n },\n {\n \"name\": \"Location\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"Age\",\n \"type\": \"FLOAT8\"\n },\n {\n \"name\": \"Species\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"MidiclorianLevel\",\n \"type\": \"FLOAT4\"\n }\n ],\n \"fileProvider\": {\n \"bucketName\": \"holocrons-bucket\",\n \"keyName\": \"secrets/data/force-sensitive-beings.csv\",\n \"transferOwnership\": true\n },\n \"skipPreface\": null,\n \"hasHeader\": false,\n \"skipEmptyLines\": false\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": null,\n \"startMillis\": null,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"KeyAlgorithm values can be 'first-column', 'column', 'row-hash', 'col-hash' and 'seq'\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-csv' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[873.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path7"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path7"}},"macroMetadata":{"macroId":{"value":"c621642438246b3d4b0b00b9af90ba3c1a63691a1acacf21c9fd7bb9d0882818"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"dc7602d3-dd32-4d00-9fed-2ea8ebdc6133"}},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Simplified endpoint to create a new lookup from a CSV file (multipart/form-data request body).","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"c767793c-3c47-4e45-a8c8-4dfc2e8cda21"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[242.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[589.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[242.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[589.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[242.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[589.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request multipart/form-data body must include the CSV file and an associated JSON configuration object. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"61302d3d-e54a-48fb-b54f-6ddb12c468ba"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[651.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"deploy-config","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[651.0]},"content":[{"type":"paragraph","content":[{"text":"Deploy CSV configuration of the lookup to be created. This object states the ","type":"text"},{"text":"visibility","type":"text","marks":[{"type":"code"}]},{"text":" of the created lookup, the ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" indicating the CSV file stored in AWS S3, the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" descriptors and ","type":"text"},{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":". It also includes metainfo from the CSV.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":"- (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Array of lookup column descriptors. Only used and required in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty. Each column object may contain the following parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Name of the column.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") 0-based index of the column in the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Data type of the column. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BOOLEAN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"STRING","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TIMESTAMP","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DURATION","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Info to get the CSV file from S3.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The name of the S3 bucket where the CSV is located.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyName","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]},{"text":"- (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The path of the CSV inside the bucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transferOwnership","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") This parameter represents whether Lomana should act as the owner of the CSV and delete it from the bucket once it has finished creating the lookup.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The access key of a customers AWS user with permissions to access the bucket represented in bucketName. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"secretKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The secret key of a customers AWS user with permissions to access the bucket represented in bucketName. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The S3 bucket host where to find the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") The S3 bucket port where to find the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The AWS region whether the S3 bucket has been created.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"). Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipPreface","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Enter a regular expression to ignore rows of data in a CSV used as source that follow the structure indicated in the regex. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hasHeader","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if the source CSV file has a header row or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipEmptyLines","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if you want to skip empty lines in the source CSV or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"contribution","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Defines how a row contributes to the final result, normally used on incremental lookups.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the contribution policy. Values can be ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"del","type":"text","marks":[{"type":"code"}]},{"text":"or ","type":"text"},{"text":"col","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The contribution will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" and its valid values are ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columnTypeReference","type":"text","marks":[{"type":"code"}]},{"text":"- (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]},{"text":"- (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"csv","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[208.0]},"content":[{"type":"paragraph","content":[{"text":"file","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[651.0]},"content":[{"type":"paragraph","content":[{"text":"CSV file to upload. Only needed if the file was not uploaded to S3.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Check more about uploading a lookup using a CSV through S3, see ","type":"text"},{"text":"this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/216825984"}}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"deploy-config\": {\n \"externalValue\": \"https://devo.com/main/files/simple-lookup-with-header/deploy-csv.json\"\n },\n \"csv\": {\n \"externalValue\": \"https://devo.com/main/files/simple-lookup-with-header/simple_lookup.csv\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"57c85144-af42-486d-9af7-ec4a994db6e3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"columns\": [\n {\n \"name\": \"ID\",\n \"type\": \"INT8\"\n },\n {\n \"name\": \"Location\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"Age\",\n \"type\": \"FLOAT8\"\n },\n {\n \"name\": \"Species\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"MidiclorianLevel\",\n \"type\": \"FLOAT4\"\n }\n ],\n \"fileProvider\": {\n \"bucketName\": \"holocrons-bucket\",\n \"keyName\": \"secrets/data/force-sensitive-beings.csv\",\n \"transferOwnership\": true\n },\n \"skipPreface\": null,\n \"hasHeader\": false,\n \"skipEmptyLines\": false\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": null,\n \"startMillis\": null,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"KeyAlgorithm values can be 'first-column', 'column', 'row-hash', 'col-hash' and 'seq'\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-csv' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path8"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path8"}},"macroMetadata":{"macroId":{"value":"1698e82c9320fd9a68e28b8a2a58d7d80024176c0eafadb27448e8e006abc501"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"abb8db33-f3f7-4dde-80b8-2c918dd0daed"}},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-static-query","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Simplified endpoint to create a new lookup based on a static query.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"59e36919-fbb6-464e-8f99-134accc313f2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"faa3f544-b3fd-429a-9818-ba808f6be83a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[382.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[503.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"query\": \"select userid, domain from siem.logtrust.web.navigation where now()-1d < eventdate < now()\",\n \"key\": {\n \"type\": \"column\",\n \"column\": \"userid\"\n },\n \"keepHistory\": false,\n \"columnTimeReference\": null\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"27dd13be-c900-434d-884d-87af5cfbd397"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"once\",\n \"source\": {\n \"query\": \"select eventdate, level, domain, userid, sessionid, correlationId from siem.logtrust.web.activity where now()-1m < eventdate < now()\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": false,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": [\n \"eventdate\",\n \"level\",\n \"domain\",\n \"userid\",\n \"sessionid\",\n \"correlationId\"\n ],\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n }\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"KeyAlgorithm values can be 'first-column', 'column', 'row-hash', 'col-hash' and 'seq'\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-static-query' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path9"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path9"}},"macroMetadata":{"macroId":{"value":"0f9bffb568c414b8368c7384080341bb3cd48b46e78e941fd3c9437e37abca34"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"77a881bd-9022-4195-934c-062d031884f0"}},{"text":" POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-periodic-query","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Simplified endpoint to create a new lookup based on a periodic query.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"b590ff18-4adc-4819-9f63-4fd17f608093"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[494.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e9dc0d41-8836-4e20-9d33-d9f315704371"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queryable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"refreshPeriod","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Refresh period of the lookup. Defaults to grouping period of the query in case it is a grouping query, or 5 minutes if not. Accepted values are the ones accepted by Devo's duration type. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The minimum value accepted is 1 minute.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"startDate","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup creation start date. Defaults to the time of the request. Can either be an ISO-8601 date time string or a number of milliseconds from Epoch.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"query\": \"select userid, domain from siem.logtrust.web.navigation where now()-5m < eventdate < now()\",\n \"key\": {\n \"type\": \"column\",\n \"column\": \"userid\"\n },\n \"refreshPeriod\": \"5m\",\n \"startDate\": \"2023-12-12T00:00:00.00Z\",\n \"append\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"aa74dff3-f2ed-42ce-9a1d-db126f029ea7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"query\": \"select eventdate, level, domain, userid, sessionid, correlationId from siem.logtrust.web.activity where now()-1m < eventdate < now()\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": 300000,\n \"startMillis\": 1702339200000,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"refreshPeriod should be bigger than 1 minute\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-periodic-query' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path10"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path10"}},"macroMetadata":{"macroId":{"value":"2832e09388aa412c2bc5b140fc41b1d30254f471c552a82b2be3cedb65f4d101"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"f068aacb-c049-471b-896a-e3ce1483608e"}},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":"/lookup/{domain}/{name}/deploy-sliding-window-query","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Simplified endpoint to create a new lookup based on a sliding window query.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"20216adc-a535-4ce2-93bc-55cfb6d97a58"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"90bcee43-9adc-42c3-abc8-a28de72cd9bd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"windowSize","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Size of the sliding window. Every time the query is executed, the lookup will contain the size of the window. Accepted values are the ones accepted by Devo duration type. The minimum value accepted is 1 hour (Example: Xh, Xd).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"refreshPeriod","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup refresh period. Defaults to querys grouping period in case of a grouping query, or 5 minutes if not. Accepted values are the ones accepted by Devo duration type. The minimum value accepted is 1 minute (Example: Xm, Xh, Xd).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"startDate","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup creation start date. Defaults to the time of the request. Can either be an ISO-8601 date time string or a number of milliseconds from Epoch.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If set to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store all historic data in the lookup, enabling historic search.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the column specified as time instant reference for the data provided.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"query\": \"from box.unix group by machine, srcIp\",\n \"key\": {\n \"type\": \"column\",\n \"column\": \"machine\"\n },\n \"windowSize\": \"30d\",\n \"refreshPeriod\" : \"5m\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c5886c5a-df2c-4894-af76-ecd3282dc0f0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 200,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"query\": \"select userid, domain from siem.logtrust.web.activity\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"userid\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": 600000,\n \"startMillis\": 1702339200000,\n \"slideWindow\": 86400000,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"refreshPeriod should be bigger than 1 minute\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-sliding-window-query' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path11"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path11"}},"macroMetadata":{"macroId":{"value":"99a0d83e4267b5b03dddaf993380aa86964de2fc0a732441996fffb099e3d465"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"4b2e20c5-0c02-4ecb-9a01-ef51f5ebab04"}},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"lookup/{domain}/{name}/deploy-config","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Update a specific lookup.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"11979e32-6786-4335-99dc-f4916b018e89"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[466.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[160.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[439.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[466.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[160.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[439.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where that contains the lookup you want to update.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[466.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[160.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[439.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to update.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"recipe","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"notifyStatus","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"id"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-id"}},"macroMetadata":{"macroId":{"value":"5eb665ae-98ce-4599-bf8c-c895fac79fcc"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"7cb461a9-d7b1-4d88-8a06-6ac7ae7ba064"}}]},{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" - Lookup ID object.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e1fb7aab-5e24-4e7f-9e19-cd0ceb762209"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[422.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[472.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[422.0]},"content":[{"type":"paragraph","content":[{"text":"creator","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[472.0]},"content":[{"type":"paragraph","content":[{"text":"Domain of the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[422.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[472.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the lookup.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Example value:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\"id\": {\n \"creator\": \"self\",\n \"name\": \"ForceSensitiveBeings\"\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"visibility"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-visibility"}},"macroMetadata":{"macroId":{"value":"cc965ad8-50c7-4035-a9cc-2efa039041cd"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"1f08be38-3e8e-4e63-9587-3f153c4836ca"}}]},{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]},{"text":" - ","type":"text"},{"text":"(string)","type":"text","marks":[{"type":"code"}]},{"text":" Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain.. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"recipe"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-recipe"}},"macroMetadata":{"macroId":{"value":"0bb79a2b-ccfc-470c-b38e-036034f4c27b"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"cd3eab17-b4ef-4bbc-bace-55097420ee0d"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"recipe","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":"- Recipe of the lookup to be updated.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3607f761-7200-48af-81f1-d3bf7190d8c9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"recipeType","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Type of the lookup recipe. Allowed values are ","type":"text"},{"text":"once","type":"text","marks":[{"type":"code"}]},{"text":" (static lookup) and ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":" (periodic lookup). Learn more about lookup types ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/space/latest/95203983/Data+enrichment"}}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"source","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Source data of the lookup to be created. This object states if the lookup will be created using a query (using the ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" field), or through a CSV file stored in AWS S3 (using the ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" field).","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Array of lookup column descriptors. Only used and required in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty. Each column object may contain the following parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Name of the column.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") 0-based index of the column in the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Data type of the column. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BOOLEAN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"STRING","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TIMESTAMP","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DURATION","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipPreface","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Enter a regular expression to ignore rows of data in a CSV used as source that follow the structure indicated in the regex. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hasHeader","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if the source CSV file has a header row or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipEmptyLines","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if you want to skip empty lines in the source CSV or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Info to get the CSV file from S3.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Name of the S3 bucket where the CSV is located.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Path of the CSV in the bucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transferOwnership","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") - Set this parameter to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" if you want to transfer the CSV ownership to Devo and delete it from the bucket once the lookup is created.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The access key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"secretKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The secret key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket host where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket port where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The AWS region where the S3 bucket has been created.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"lookupType","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Indicate the lookup type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Valid values are ","type":"text"},{"text":"normal","type":"text","marks":[{"type":"code"}]},{"text":" (regular lookups) and ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"time range lookups","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.devo.com/space/latest/95204060/Create+a+lookup+table+from+a+query#Time-range-lookups"}}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"instantPolicy","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Defines how to calculate the instant of each row. Only used when the generated lookup type is ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":". Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"natural","type":"text","marks":[{"type":"code"}]},{"text":" - The associated source must be historical and the instant of each row will be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"const","type":"text","marks":[{"type":"code"}]},{"text":" - The instance of all rows will be the supplied constant value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The instance will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"timestamp","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"instant","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"number","type":"text","marks":[{"type":"code"}]},{"text":") Only for ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":" lookups of type ","type":"text"},{"text":"const","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columnName","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Only for ","type":"text"},{"text":"historic","type":"text","marks":[{"type":"code"}]},{"text":" lookups of type ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. ","type":"text"}]},{"type":"paragraph","content":[{"text":"However, note that if there is no previous lookup or the recipe is updated (that is to say, the query is modified), this property will be ignored and the lookup will be recreated. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"columnFilter","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"If not null, a white list of columns will be projected. All elements of the list must be defined by the source. Columns whose name is not on this list won't be projected.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"contribution","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Defines how a row contributes to the final result, normally used on incremental lookups.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the contribution policy. Values can be ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"del","type":"text","marks":[{"type":"code"}]},{"text":"or ","type":"text"},{"text":"col","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The contribution will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" and its valid values are ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"secondaryIndexes","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Columns of a lookup indexed as secondary indexes.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the secondary indexes to be applied to the lookup. Values can be ","type":"text"},{"text":"all","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"none","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"by-name","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"none","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"map","type":"text","marks":[{"type":"code"}]},{"text":" - Map of column names to be applied as secondary indexes when the type selected is ","type":"text"},{"text":"by-name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"refreshMillis","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Refresh time of the lookup. Can only be used and is required if the recipe ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" chosen is ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"startMillis","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"number","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"Millis since Epoch. Can only be used and is required if the recipe ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" chosen is ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"requiresDate","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[74.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[602.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the source query will be enriched with a closed date range restriction. The lower bound will be the maximum between ","type":"text"},{"text":"startMillis","type":"text","marks":[{"type":"code"}]},{"text":" and the last job instant, and the upper bound will be always ","type":"text"},{"text":"now()","type":"text","marks":[{"type":"code"}]},{"text":". Can only be used if the recipe type chosen is ","type":"text"},{"text":"periodic","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"status"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-status"}},"macroMetadata":{"macroId":{"value":"1454b131-10db-4535-8f7e-2188f48d7eb4"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"4fee552d-6754-4870-afd2-c01191e2bd64"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"notifyStatus","type":"text","marks":[{"type":"code"}]},{"text":"- (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", a notification will be sent to the Devo app once the lookup is executed. If you do not include this parameter, it will be ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":" by default.","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"TotallyNotFakeData\"\n },\n \"recipe\": {\n \"recipeType\": \"once\",\n \"source\": {\n \"query\": \"select 0 as key, false as IsDataFake, 2147483647 as RebelsImprisoned, 9223372036854775807 as CreditsOnImperialBanks, hex4('fffffff') as Hex4Emperor, hex8('fffffffffffffff') as Hex8Vader, 2.718281828459045 as EmperorClones, 3.141592653589793 as Pi, 87.219.9.157 as EmperorIP4, ip6('fe80::4492:bc4b:7a53:c0d5') as EmperorIP6, 0m as TimeAfterBattleOfYavin from siem.logtrust.web.navigation where now()-1m < eventdate < now() limit 1\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": false,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": [\n \"key\",\n \"IsDataFake\",\n \"RebelsImprisoned\",\n \"CreditsOnImperialBanks\",\n \"Hex4Emperor\",\n \"Hex8Vader\",\n \"EmperorClones\",\n \"Pi\",\n \"EmperorIP4\",\n \"EmperorIP6\",\n \"TimeAfterBattleOfYavin\"\n ],\n \"contribution\": {\n \"type\": \"add\"\n },\n \"requiresDate\": false\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7a4f74d5-4593-4a65-a147-626d77c88ddd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[352.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[713.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[352.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[713.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d41c91a21d56\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"xxxxxx-2201-11ec-b04a-53c6289921cb\",\n \"msg\": \"Lookup sent to creation\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": \"creator-only\",\n \"recipe\": {\n \"type\": \"once\",\n \"source\": {\n \"query\": \"select eventdate, level, domain, userid, sessionid, correlationId from siem.logtrust.web.activity where now()-1m < eventdate < now()\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": false,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": [\n \"eventdate\",\n \"level\",\n \"domain\",\n \"userid\",\n \"sessionid\",\n \"correlationId\"\n ],\n \"contribution\": {\n \"type\": \"add\"\n }\n }\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[352.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[713.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": \"BAD_REQUEST\",\n \"id\": \"xxxxxx-5151-11ed-859a-5d2974203ed5\",\n \"message\": \"Bad Request\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[352.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[713.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[352.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[713.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. User credentials are correct but does not have permission to update this lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"9a3eda1848d1\",\n \"code\": 403,\n \"context\": \"FORBIDDEN\",\n \"id\": \"xxxxxx5055-11ed-859a-7b524e50491a\",\n \"msg\": \"User is not authorized to perform operations in the domain.\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path12"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path12"}},"macroMetadata":{"macroId":{"value":"763bcd4f8be08316bc59e7063cefd18e6dd0ab8df9a9a93e2868861b889ccea1"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"8bc54997-94fe-4520-b439-2f10f82780fd"}},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Update a CSV lookup (application/json request body).","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"0631fb67-6127-4c59-b999-9010e84283d7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the domain name of the lookup you want to update.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to update.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"518e840e-3a81-4cd0-9102-8115e1848f04"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Array of lookup column descriptors. Each column object may contain the following parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Name of the column.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") 0-based index of the column in the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Data type of the column. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BOOLEAN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"STRING","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TIMESTAMP","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DURATION","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"array","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Info to get the CSV file from S3.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Name of the S3 bucket where the CSV is located.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - Path of the CSV in the bucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transferOwnership","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") - Set this parameter to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" if you want to transfer the CSV ownership to Devo and delete it from the bucket once the lookup is created.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The access key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"secretKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The secret key of a customers AWS user with permissions to access the bucket represented in the ","type":"text"},{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket host where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") - The S3 bucket port where the CSV is located. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") - The AWS region where the S3 bucket has been created.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"skipPreface","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Enter a regular expression to ignore rows of data in a CSV used as source that follow the structure indicated in the regex. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"hasHeader","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Indicate if the source CSV file has a header row or not. Only used in CSV sources with fileProvider parameter informed and query parameter empty. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"skipEmptyLines","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Indicate if you want to skip empty lines in the source CSV or not. Only used in CSV sources with fileProvider parameter informed and query parameter empty. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"contribution","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Defines how a row contributes to the final result, normally used on incremental lookups.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the contribution policy. Values can be ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"del","type":"text","marks":[{"type":"code"}]},{"text":"or ","type":"text"},{"text":"col","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The contribution will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" and its valid values are ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"columns\": [\n {\n \"name\": \"ID\",\n \"type\": \"INT8\"\n },\n {\n \"name\": \"Location\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"Age\",\n \"type\": \"FLOAT8\"\n },\n {\n \"name\": \"Species\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"MidiclorianLevel\",\n \"type\": \"FLOAT4\"\n }\n ],\n \"key\": {\n \"type\": \"column\",\n \"column\": \"ID\"\n },\n \"fileProvider\": {\n \"bucketName\": \"holocrons-bucket\",\n \"keyName\": \"secrets/data/force-sensitive-beings.csv\",\n \"transferOwnership\": true\n },\n \"contribution\": {\n \"type\": \"add\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e29534c4-93d2-4c2e-95af-5d33e5cbc200"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupUpdateResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"columns\": [\n {\n \"name\": \"ID\",\n \"type\": \"INT8\"\n },\n {\n \"name\": \"Location\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"Age\",\n \"type\": \"FLOAT8\"\n },\n {\n \"name\": \"Species\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"MidiclorianLevel\",\n \"type\": \"FLOAT4\"\n }\n ],\n \"fileProvider\": {\n \"bucketName\": \"holocrons-bucket\",\n \"keyName\": \"secrets/data/force-sensitive-beings.csv\",\n \"transferOwnership\": true\n },\n \"skipPreface\": null,\n \"hasHeader\": false,\n \"skipEmptyLines\": false\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": null,\n \"startMillis\": null,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"KeyAlgorithm values can be 'first-column', 'column', 'row-hash', 'col-hash' and 'seq'\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-csv' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path13"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path13"}},"macroMetadata":{"macroId":{"value":"10f8ea55f34dbdab8dfe1cd83f8af8a0b2ab15d80f7b48a0b9e0575643217f2f"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"2f2d3b60-1afa-4dab-b815-d6cd2f6571f3"}},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"lookup/{domain}/{name}/deploy-csv","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Update a CSV lookup (multipart/form-data request body).","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"23df20e6-b6d5-4857-bdb7-fc727887f1f6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[370.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[198.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[497.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[370.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[198.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[497.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[370.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[198.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[497.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request multipart/form-data body must include the CSV file and an associated JSON configuration object. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8c600c05-a1f5-415e-bec3-68731f848e3e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[347.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[188.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[347.0]},"content":[{"type":"paragraph","content":[{"text":"deploy-config","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[188.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","content":[{"text":"Deploy CSV configuration of the lookup to be created. This object states the ","type":"text"},{"text":"visibility","type":"text","marks":[{"type":"code"}]},{"text":" of the created lookup, the ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" indicating the CSV file stored in AWS S3, the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" descriptors and ","type":"text"},{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":". It also includes metainfo from the CSV.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":"- (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Array of lookup column descriptors. Only used and required in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty. Each column object may contain the following parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Name of the column.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") 0-based index of the column in the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Data type of the column. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BOOLEAN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"STRING","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"INT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FLOAT8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HEX8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IP6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TIMESTAMP","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DURATION","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Info to get the CSV file from S3.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bucketName","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The name of the S3 bucket where the CSV is located.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyName","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]},{"text":"- (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The path of the CSV inside the bucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"transferOwnership","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") This parameter represents whether Lomana should act as the owner of the CSV and delete it from the bucket once it has finished creating the lookup.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The access key of a customers AWS user with permissions to access the bucket represented in bucketName. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"secretKey","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The secret key of a customers AWS user with permissions to access the bucket represented in bucketName. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The S3 bucket host where to find the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"integer","type":"text","marks":[{"type":"code"}]},{"text":") The S3 bucket port where to find the CSV.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The AWS region whether the S3 bucket has been created.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":"). Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipPreface","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Enter a regular expression to ignore rows of data in a CSV used as source that follow the structure indicated in the regex. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hasHeader","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if the source CSV file has a header row or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"skipEmptyLines","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") Indicate if you want to skip empty lines in the source CSV or not. Only used in CSV sources with ","type":"text"},{"text":"fileProvider","type":"text","marks":[{"type":"code"}]},{"text":" parameter informed and ","type":"text"},{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" parameter empty.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"contribution","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"array","type":"text","marks":[{"type":"code"}]},{"text":") Defines how a row contributes to the final result, normally used on incremental lookups.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of the contribution policy. Values can be ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"del","type":"text","marks":[{"type":"code"}]},{"text":"or ","type":"text"},{"text":"col","type":"text","marks":[{"type":"code"}]},{"text":". The default value is ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") The contribution will be extracted from the column with the given name. That column type must be ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" and its valid values are ","type":"text"},{"text":"add","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"delete","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columnTypeReference","type":"text","marks":[{"type":"code"}]},{"text":"- (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]},{"text":"- (","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]},{"text":") If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[347.0]},"content":[{"type":"paragraph","content":[{"text":"csv","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[188.0]},"content":[{"type":"paragraph","content":[{"text":"file","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","content":[{"text":"CSV file to upload. Only needed if the file was not uploaded to S3.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Check more about uploading a lookup using a CSV through S3, see ","type":"text"},{"text":"this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/216825984"}}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"deploy-config\": {\n \"externalValue\": \"https://devo.com/main/files/simple-lookup-with-header/deploy-csv.json\"\n },\n \"csv\": {\n \"externalValue\": \"https://devo.com/main/files/simple-lookup-with-header/simple_lookup.csv\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c5a896f6-ce21-4552-95bc-b41d0bc1937c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"columns\": [\n {\n \"name\": \"ID\",\n \"type\": \"INT8\"\n },\n {\n \"name\": \"Location\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"Age\",\n \"type\": \"FLOAT8\"\n },\n {\n \"name\": \"Species\",\n \"type\": \"STRING\"\n },\n {\n \"name\": \"MidiclorianLevel\",\n \"type\": \"FLOAT4\"\n }\n ],\n \"fileProvider\": {\n \"bucketName\": \"holocrons-bucket\",\n \"keyName\": \"secrets/data/force-sensitive-beings.csv\",\n \"transferOwnership\": true\n },\n \"skipPreface\": null,\n \"hasHeader\": false,\n \"skipEmptyLines\": false\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": null,\n \"startMillis\": null,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"KeyAlgorithm values can be 'first-column', 'column', 'row-hash', 'col-hash' and 'seq'\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-csv' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path14"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path14"}},"macroMetadata":{"macroId":{"value":"56be4f8938ae3e6763a32ce1784f567cec168f32d6556e4c5ba9e3ceb0b8079f"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"dec45a73-7a6d-4c62-84f3-80f837c20bc3"}},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"lookup/{domain}/{name}/deploy-static-query","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Update a lookup based on a static query.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"650f525d-75a6-40ca-a427-31414db8de7a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the domain name of the lookup you want to update.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to update.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"58feb7de-c71a-486c-87c8-f49ecd1904e6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"query\": \"select userid, domain from siem.logtrust.web.navigation where now()-1d < eventdate < now()\",\n \"key\": {\n \"type\": \"column\",\n \"column\": \"userid\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"419af3be-1b78-4517-8080-6ee5ffe15421"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"201","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"once\",\n \"source\": {\n \"query\": \"select eventdate, level, domain, userid, sessionid, correlationId from siem.logtrust.web.activity where now()-1m < eventdate < now()\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": false,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": [\n \"eventdate\",\n \"level\",\n \"domain\",\n \"userid\",\n \"sessionid\",\n \"correlationId\"\n ],\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n }\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"KeyAlgorithm values can be 'first-column', 'column', 'row-hash', 'col-hash' and 'seq'\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-static-query' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path15"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path15"}},"macroMetadata":{"macroId":{"value":"96c6ddbfddac1a7a276659b1b7db5639415948223d64adb36dfc77c58ff3c6e6"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"63e66b20-faba-4d2e-9a7e-ecb808859910"}},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"lookup/{domain}/{name}/deploy-periodic-query","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Update a lookup based on a periodic query.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"1c15554b-a7e8-41d6-a45f-bc29d759f97d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the domain name of the lookup you want to update.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to update.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ce21880b-6705-4195-9b6a-7b8aa62bd6f6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queryable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"refreshPeriod","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Refresh period of the lookup. Defaults to grouping period of the query in case it is a grouping query, or 5 minutes if not. Accepted values are the ones accepted by Devo's duration type. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The minimum value accepted is 1 minute.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"startDate","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup creation start date. Defaults to the time of the request. Can either be an ISO-8601 date time string or a number of milliseconds from Epoch.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. ","type":"text"}]},{"type":"paragraph","content":[{"text":"However, note that if there is no previous lookup or the recipe is updated (that is to say, the query is modified), this property will be ignored and the lookup will be recreated. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"append","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", when this recipe is evaluated, the content of its source will be appended to the lookup created on the previous evaluation. If there is no previous lookup, or if the recipe is updated, this property is ignored. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store in the lookup all historic data, enabling historic search. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the specified column as time instant reference for the data provided.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"query\": \"select userid, domain from siem.logtrust.web.navigation where now()-5m < eventdate < now()\",\n \"key\": {\n \"type\": \"column\",\n \"column\": \"userid\"\n },\n \"refreshPeriod\": \"5m\",\n \"startDate\": \"now\",\n \"append\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b496a4c6-2433-4d7d-a672-ab0343b02207"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 201,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"query\": \"select eventdate, level, domain, userid, sessionid, correlationId from siem.logtrust.web.activity where now()-1m < eventdate < now()\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"key\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": 300000,\n \"startMillis\": 1702339200000,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"refreshPeriod should be bigger than 1 minute\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-periodic-query' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path16"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path16"}},"macroMetadata":{"macroId":{"value":"c8e87ba107e823b8a1ac7ebf6e5ea6edf6cd86324a0def8d09059b254db642a3"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"3d077042-54b5-4c7b-b5fe-6f74f7e25c15"}},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"lookup/{domain}/{name}/deploy-sliding-window-query","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Update a lookup based on a sliding window query.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"9f31865e-8ef3-4fd7-843d-b73bbf96f9b9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain where you want to create the lookup.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[195.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[495.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to create.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following objects and key-value pairs. Click them in the following list to see its details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"beaad6ed-db44-4bb2-98e0-969987ce62fd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"visibility","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Visibility level of the lookup. Allowed values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"creator-only","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be visible only in the creator's domain. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" - The lookup will be queriable in all the subdomains in a multitenant domain. It will only be visible in the lookup management web page in the root domain. Only multitenant Admin users will be able to use this value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"all-domains","type":"text","marks":[{"type":"code"}]},{"text":" - To create a lookup visible by all domains. It is only allowed when the domain of the user is self.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Lookup ownership VS visibility","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup ownership","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain where the lookup is defined.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Lookup visibility","type":"text","marks":[{"type":"underline"}]},{"text":" refers to the domain(s) where a lookup is visible. Note that lookups are created in a specific Devo domain, but they can be visible in other domains as well. If your domain belongs to a multitenant structure, you can use the ","type":"text"},{"text":"all-subdomains","type":"text","marks":[{"type":"code"}]},{"text":" parameter defined above to make it visible in all the domains within the structure.","type":"text"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"query","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Query to generate the lookup from. It must be written using LINQ syntax. Allowed field data types are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"float8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hex8","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip4","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ip6","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"In case the key of the lookup is not the name of a column, it can be computed through an algorithm using the elements on this data type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") List of columns to be used to generate the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"col-hash","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":")Name of the column to be used as the key for the lookup. This is only used when the ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" of the object is ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - (","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":") Type of key algorithm. Values can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"first-column","type":"text","marks":[{"type":"code"}]},{"text":" - The first column of the lookup will be used as key. This is the default value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" - The column indicated in the ","type":"text"},{"text":"column","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the elements on the first row of the lookup will be used as key.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"col-hash","type":"text","marks":[{"type":"code"}]},{"text":" - A hash of the columns stated in the ","type":"text"},{"text":"columns","type":"text","marks":[{"type":"code"}]},{"text":" parameter will be used as key. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" - The key of the lookup will be generated sequentially.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"windowSize","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Size of the sliding window. Every time the query is executed, the lookup will contain the size of the window. Accepted values are the ones accepted by Devo duration type. The minimum value accepted is 1 hour (Example: Xh, Xd).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"refreshPeriod","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#bf2600"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup refresh period. Defaults to querys grouping period in case of a grouping query, or 5 minutes if not. Accepted values are the ones accepted by Devo duration type. The minimum value accepted is 1 minute (Example: Xm, Xh, Xd).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"startDate","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"Lookup creation start date. Defaults to the time of the request. Can either be an ISO-8601 date time string or a number of milliseconds from Epoch.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"keepHistory","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If set to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", the Lookup Manager will store all historic data in the lookup, enabling historic search.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[381.0]},"content":[{"type":"paragraph","content":[{"text":"columnTimeReference","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[504.0]},"content":[{"type":"paragraph","content":[{"text":"If given, the Lookup Manager will use the column specified as time instant reference for the data provided.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Check below an example of request body:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"query\": \"from box.unix group by machine, srcIp\",\n \"key\": {\n \"type\": \"column\",\n \"column\": \"machine\"\n },\n \"windowSize\": \"30d\",\n \"refreshPeriod\" : \"5m\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2c94a1d5-21d0-429e-9c49-ab6bb8c678f5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Request submitted. The response includes the ID of the update request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationResponse\",\n \"cid\": \"d5ce4eb105b2\",\n \"code\": 200,\n \"context\": null,\n \"id\": \"c6b1e939-a57c-11ee-b1a9-a124bba45b9b\",\n \"msg\": \"Lookup sent to creation. You can check the creation status using the provided id: /lookup/{domain}/{name}/job/{id}\",\n \"lookupDeployConfig\": {\n \"id\": {\n \"creator\": \"rebel_alliance\",\n \"name\": \"GalacticEmpireActivity\"\n },\n \"visibility\": {\n \"type\": \"creator-only\"\n },\n \"recipe\": {\n \"recipeType\": \"periodic\",\n \"source\": {\n \"query\": \"select userid, domain from siem.logtrust.web.activity\"\n },\n \"lookupType\": {\n \"type\": \"normal\"\n },\n \"append\": true,\n \"key\": {\n \"type\": \"column\",\n \"column\": \"userid\"\n },\n \"columnFilter\": null,\n \"contribution\": {\n \"type\": \"add\"\n },\n \"secondaryIndexes\": {\n \"type\": \"none\"\n },\n \"refreshMillis\": 600000,\n \"startMillis\": 1702339200000,\n \"slideWindow\": 86400000,\n \"requiresDate\": true\n },\n \"notifyStatus\": true\n }\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"0cd289fa1b63\",\n \"code\": 400,\n \"context\": null,\n \"id\": \"9f270aca-5151-11ed-859a-5d2974203ed5\",\n \"msg\": \"refreshPeriod should be bigger than 1 minute\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to update the lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 401,\n \"msg\": \"Access to 'https://api.us.devo.com/lookup-api/lookup/galactic_empire/destroyed_planets/deploy-sliding-window-query' requires valid auth\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Forbidden access.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"code\": 5,\n \"msg\": \"Token invalid or expired\",\n \"cid\": \"29fda52318ae\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Domain not found.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 404,\n \"context\": null,\n \"id\": \"901c6154-b16b-11ee-b3ab-47fc28cf5888\",\n \"msg\": \"Domain not found.\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[337.0]},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[728.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. Lookup already exists.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupCreationError\",\n \"cid\": \"68e612d824a5\",\n \"code\": 409,\n \"context\": null,\n \"id\": \"9b6b0f0e-b162-11ee-b3ab-77fd619670ef\",\n \"msg\": \"Lookup with domain galactic_empire and name destroyed_planets already exists\"\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path17"},"legacyAnchorId":{"value":"WorkingwiththeLookupsAPI-path17"}},"macroMetadata":{"macroId":{"value":"dd259b480424bf9a417e6fed53c84c32fd92066de5b2a0b0dbe7aeff52a6aba2"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"a1fb3599-00c3-43f1-ad58-7605db4c548f"}},{"text":"DELETE","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":"/lookup/{domain}/{name}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Send a request to delete a specific lookup.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"17c5033d-8df4-419e-ab6c-c624a5999073"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[491.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[491.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the domain that contains the lookup you want to delete.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[491.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the lookup you want to delete.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"Find below a request example in cURL language. This request will return information about the 10 oldest lookups created in the domain indicated. Learn how to authorize your request ","type":"text"},{"text":"in this article","type":"text","marks":[{"type":"link","attrs":{"href":"https://devodocs.atlassian.net/wiki/spaces/latest/pages/127500308"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -H \"standAloneToken:YOUR_TOKEN\" -X DELETE https://api-us.devo.com/lookup-api/lookup/myDomain/myLookup","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"fd7985c2-2bda-4fed-8621-022d54eb9ce5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[251.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[814.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[251.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[814.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Deletion request sent. The response includes the ID of the request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"type\": \"LookupDeletionResponse\",\n \"cid\": \"f44f458f7c32\",\n \"code\": 200,\n \"context\": null,\n \"id\": \"xxxxxx-5052-11ed-b24b-85c623a0cbd8\",\n \"msg\": \"Lookup sent to deletion\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[251.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[814.0]},"content":[{"type":"paragraph","content":[{"text":"Unsuccessful response. The user is unauthorized to delete this lookup.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}","type":"text"}]}]}]}]}],"version":1}

Browser not supported