Create manifest (POST)

Create manifest is a Notify API method that can be used to create a new manifest.

See also:

Usage

Request method:
POST

Request URL:

{baseUrl}/notify-api/tenants/local/installations/local/environments/local/source-systems/{sourceSystemName}/source-entities/{sourceEntityName}/manifests

where:

{baseUrl}, {sourceSystemName}, {sourceEntityName} see Notify API.

Request body:

JSON

{
    "batch": {integer},
    "columns": {array},
    "compression": {string},
    "delim": {string},
    "format": {string},
    "fullscanned": {boolean},
    "skiph": {integer}
}

See Notify API for property descriptions and guidelines.

Notes

All entries added to a manifest should follow the same definition. I.e. you cannot, for example, load manifests containing both CSV and JSON files or load multiple CSV files with different delimiters.

A manifest is created in the OPEN state and can be modified by using the PUT method until it is notified.

Examples

Create a manifest

Property	Value
sourceSystemName	taxidata
sourceEntityName	ratecode_description

Request method:

POST

Request URL:

{base_url}/notify-api/tenants/local/installations/local/environments/local/source-systems/taxidata/source-entities/ratecode_description/manifests

Request body:

JSON

{
    "batch": 1619165856095,
    "columns": ["ratecodeid", "description"],
    "compression": "GZIP",
    "delim": "COMMA",
    "format": "CSV",
    "fullscanned": true,
    "skiph": 1
}

Response code:

201 (Created)

Response body:

JSON

{
    "id": "a936c9c5-a2d5-4d1a-bcf5-7832f21342ca",
    "state": "OPEN",
    "columns": [
        "ratecodeid",
        "description"
    ],
    "batch": 1619165856095,
    "fullscanned": true,
    "delim": "COMMA",
    "skiph": 1,
    "compression": "GZIP",
    "format": "CSV",
    "created": "2021-04-23T08:20:04.975861",
    "modified": "2021-04-23T08:20:04.976541"
}