Register Containerized Extractor

1 curl -X POST https://api.gov.nominal.io/api/extractors/v1/container \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "name", 6 "image": { 7 "registry": "registry", 8 "repository": "repository", 9 "tagDetails": { 10 "tags": [ 11 "tags" 12 ], 13 "defaultTag": "defaultTag" 14 }, 15 "authentication": { 16 "type": "userAndPassword", 17 "userAndPassword": { 18 "username": "username", 19 "passwordSecretRid": "passwordSecretRid" 20 } 21 } 22 }, 23 "inputs": [ 24 { 25 "environmentVariable": "environmentVariable", 26 "name": "name", 27 "fileFilters": [ 28 { 29 "type": "suffix", 30 "suffix": "fileFilters" 31 }, 32 { 33 "type": "suffix", 34 "suffix": "fileFilters" 35 } 36 ] 37 }, 38 { 39 "environmentVariable": "environmentVariable", 40 "name": "name", 41 "fileFilters": [ 42 { 43 "type": "suffix", 44 "suffix": "fileFilters" 45 }, 46 { 47 "type": "suffix", 48 "suffix": "fileFilters" 49 } 50 ] 51 } 52 ], 53 "properties": { 54 "properties": "properties" 55 }, 56 "labels": [ 57 "labels" 58 ], 59 "workspace": "workspace", 60 "timestampMetadata": { 61 "seriesName": "seriesName", 62 "timestampType": { 63 "type": "relative", 64 "relative": { 65 "timeUnit": "DAYS" 66 } 67 } 68 } 69 }'

1 { 2 "extractorRid": "extractorRid" 3 }

Registers a containerized extractor for a given set of containerized files.

Request

This endpoint expects an object.

namestringRequired

imageobjectRequired

inputslist of objectsRequired

payload must match input defined in containerized extraction

propertiesmap from strings to stringsRequired

labelsset of stringsRequired

workspacestringRequired

The workspace in which to create the extractor

timestampMetadataobjectRequired

Metadata about the intermediate parquet this extractor will produce

descriptionstringOptional

Response

This endpoint returns an object.

extractorRidstring

Headers

Request

Response