# Add catalog
- Operation ID: `addBag`
- HTTP method: `POST`
- Path: `/catalogs/bags`
- [Human-readable API reference](https://hub.synerise.com/api-reference/data-management#tag/Catalogs/operation/addBag)
## Self-contained OpenAPI method
The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.
```yaml
openapi: 3.0.0
info:
title: Synerise Public API
version: 1.9.1
paths:
/catalogs/bags:
post:
tags:
- Catalogs
summary: Add catalog
description: |
Create a new, empty catalog.
---
**API consumers:** Synerise User, Workspace (Business Profile)
**API key permission required:** `CATALOGS_CATALOG_CREATE`
**User role permission required:** `assets_catalogs: create`
operationId: addBag
security:
- JWT: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Catalog name
required: true
responses:
"200":
description: Details of the created catalog
content:
application/json:
schema:
type: object
properties:
data:
type: object
description: This object holds the details of the catalog.
properties:
id:
type: integer
description: Catalog ID
name:
type: string
description: Catalog name
businessProfileId:
type: integer
description: ID of the Business Profile that contains this catalog
createdBy:
type: object
description: Data of user
properties:
id:
type: integer
description: Id of the user
name:
type: string
description: Name of the user
iconUrl:
type: string
description: URL of the user's avatar icon
creationDate:
format: date-time
type: string
description: Creation date
modifiedBy:
type: object
description: Data of user
properties:
id:
type: integer
description: Id of the user
name:
type: string
description: Name of the user
iconUrl:
type: string
description: URL of the user's avatar icon
lastModified:
type: string
format: date-time
description: Last modification date
primaryKey:
type: object
required:
- name
properties:
name:
type: string
description:
type: string
mappings:
type: array
items:
type: object
required:
- bpActionParamKey
- bagId
- itemId
- action
- paramKey
- enrichmentFields
properties:
bpActionParamKey:
type: string
bagId:
type: integer
format: int64
itemId:
type: integer
format: int64
action:
type: string
paramKey:
type: string
enrichmentFields:
type: array
items:
type: string
beforeFiltering:
type: boolean
fields:
type: array
items:
type: string
metaData:
type: object
description: This object holds the metadata of the response.
properties:
totalCount:
type: integer
description: The total number of matching values (key-value pairs; array items; objects) in the database
requestTime:
type: string
description: The processing time of the request
example: 0.11 [s]
"400":
description: Invalid or insufficient data
content:
text/plain:
schema:
type: string
"401":
description: "Unauthorized: token missing/expired/invalid; invalid API key; etc."
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: Status code
error:
type: string
description: Error summary
message:
type: string
description: Error message
timestamp:
type: string
description: Time when the error occurred
"403":
description: "Forbidden: insufficient permissions; wrong consumer scope"
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: Status code
error:
type: string
description: Error summary
message:
type: string
description: Error message
timestamp:
type: string
description: Time when the error occurred
x-snr-doc-urls:
- /api-reference/data-management#tag/Catalogs/operation/addBag
x-codeSamples:
- lang: cURL
label: cURL
source: |-
curl --request POST \
--url https://api.synerise.com/catalogs/bags \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"name":"string"}'
- lang: Python
label: Python
source: |-
import http.client
conn = http.client.HTTPSConnection("api.synerise.com")
payload = "{\"name\":\"string\"}"
headers = {
'Authorization': "Bearer REPLACE_BEARER_TOKEN",
'content-type': "application/json"
}
conn.request("POST", "/catalogs/bags", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
- lang: JavaScript
label: JavaScript
source: |-
const data = JSON.stringify({
"name": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.synerise.com/catalogs/bags");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);
- lang: Node.js
label: Node.js
source: |-
const http = require("https");
const options = {
"method": "POST",
"hostname": "api.synerise.com",
"port": null,
"path": "/catalogs/bags",
"headers": {
"Authorization": "Bearer REPLACE_BEARER_TOKEN",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({name: 'string'}));
req.end();
- lang: PHP
label: PHP
source: |-
setUrl('https://api.synerise.com/catalogs/bags');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',
'content-type' => 'application/json'
]);
$request->setBody('{"name":"string"}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
- lang: Java
label: Java
source: |-
HttpResponse response = Unirest.post("https://api.synerise.com/catalogs/bags")
.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")
.header("content-type", "application/json")
.body("{\"name\":\"string\"}")
.asString();
servers:
- description: Microsoft Azure EU
url: https://api.synerise.com
- description: Microsoft Azure USA
url: https://api.azu.synerise.com
- description: Google Cloud Platform
url: https://api.geb.synerise.com
tags:
- name: Catalogs
components:
securitySchemes:
JWT:
type: http
scheme: bearer
description: |-
JWT Bearer token. The header looks like this: `Bearer {JWT}`
Remember to include the space between 'Bearer' and the token.
Generate a token via the **Authorization** endpoints.
```