# Preview document content for a profile
- Operation ID: `previewDocumentByIdentifierPost`
- HTTP method: `POST`
- Path: `/schema-service/v2/documents/preview/by/{identifierType}`
- [Human-readable API reference](https://hub.synerise.com/api-reference/asset-management#tag/Documents/operation/previewDocumentByIdentifierPost)
## 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:
/schema-service/v2/documents/preview/by/{identifierType}:
post:
tags:
- Documents
summary: Preview document content for a profile
description: |
Preview document content in context of a profile. Inserts are processed. If an insert can't be processed, the returned `content` is empty.
This method should not be used in production implementations, its purpose is to test the content. Use the "generate document" endpoints for implementation.
---
**API consumers:** Workspace (Business Profile), Synerise User
**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`
**User role permission required:** `assets_docs: read`
operationId: previewDocumentByIdentifierPost
security:
- JWT: []
parameters:
- in: path
name: identifierType
description: Type of the profile identifier. The value is sent in `identifierValue` in the request body.
required: true
schema:
type: string
enum:
- id
- uuid
- email
- custom_identify
requestBody:
content:
application/json:
schema:
type: object
required:
- identifierValue
- content
properties:
identifierValue:
type: string
description: Value of the profile identifier selected in `identifierType` (profile ID is sent as a string)
content:
description: Content of the document. It can contain inserts.
anyOf:
- type: object
example:
someBoolean: true
someString: Lorem ipsum
aNestedDocument: "{% document exampleslug %}"
additionalProperties: true
- type: string
example: "{% document exampleslug %}"
params:
type: object
description: Additional parameters
additionalProperties:
description: |
If you are generating the resource with a context that doesn't have the data for inserts in the resource (for example, a document has a `{% customer param %}` insert, but you're authenticated with a workspace JWT, so the customer context can't be extracted from the JWT), you can include the parameters in the request body. If an insert can't be processed, the returned content is empty.
**Usage example**: if the `{% customer firstName %}` insert is used in a document, you can pass its value by sending `"customer.firstName": "Joe"`
Because inserts are always encapsulated with quotation marks, inserts that return a number or a boolean value return it as a string.
anyOf:
- type: string
- type: number
responses:
"200":
description: Processed document
content:
application/json:
schema:
description: Content of the document
anyOf:
- type: object
description: The processed JSON content of the document
additionalProperties:
description: JSON keys in the document and their values
example:
someBoolean: true
someString: Lorem ipsum
aNestedDocument:
uuid: 772d94f7-a604-409a-bfa9-24a64b8a5051
slug: apple
schema: fruit
content:
color: red
- type: string
description: Processed string value of a document (for example, a small document which only includes an insert to return an expression result)
"400":
description: See error message for details
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
"401":
description: "Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc."
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
description: Time when the error occurred
error:
type: string
description: Summary of the error
message:
type: string
description: Description of the problem
status:
type: integer
format: int32
description: HTTP status code
"403":
description: Forbidden; insufficient permissions
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
description: Time when the error occurred
error:
type: string
description: Summary of the error
message:
type: string
description: Description of the problem
status:
type: integer
format: int32
description: HTTP status code
"404":
description: Resource not found
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
"500":
description: See error message for details
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
x-snr-doc-urls:
- /api-reference/asset-management#tag/Documents/operation/previewDocumentByIdentifierPost
x-codeSamples:
- lang: cURL
label: cURL
source: |-
curl --request POST \
--url https://api.synerise.com/schema-service/v2/documents/preview/by/%7BidentifierType%7D \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"identifierValue":"string","content":{"someBoolean":true,"someString":"Lorem ipsum","aNestedDocument":"{% document exampleslug %}"},"params":{"property1":"string","property2":"string"}}'
- lang: Python
label: Python
source: |-
import http.client
conn = http.client.HTTPSConnection("api.synerise.com")
payload = "{\"identifierValue\":\"string\",\"content\":{\"someBoolean\":true,\"someString\":\"Lorem ipsum\",\"aNestedDocument\":\"{% document exampleslug %}\"},\"params\":{\"property1\":\"string\",\"property2\":\"string\"}}"
headers = {
'Authorization': "Bearer REPLACE_BEARER_TOKEN",
'content-type': "application/json"
}
conn.request("POST", "/schema-service/v2/documents/preview/by/%7BidentifierType%7D", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
- lang: JavaScript
label: JavaScript
source: |-
const data = JSON.stringify({
"identifierValue": "string",
"content": {
"someBoolean": true,
"someString": "Lorem ipsum",
"aNestedDocument": "{% document exampleslug %}"
},
"params": {
"property1": "string",
"property2": "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/schema-service/v2/documents/preview/by/%7BidentifierType%7D");
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": "/schema-service/v2/documents/preview/by/%7BidentifierType%7D",
"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({
identifierValue: 'string',
content: {
someBoolean: true,
someString: 'Lorem ipsum',
aNestedDocument: '{% document exampleslug %}'
},
params: {property1: 'string', property2: 'string'}
}));
req.end();
- lang: PHP
label: PHP
source: |-
setUrl('https://api.synerise.com/schema-service/v2/documents/preview/by/%7BidentifierType%7D');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',
'content-type' => 'application/json'
]);
$request->setBody('{"identifierValue":"string","content":{"someBoolean":true,"someString":"Lorem ipsum","aNestedDocument":"{% document exampleslug %}"},"params":{"property1":"string","property2":"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/schema-service/v2/documents/preview/by/%7BidentifierType%7D")
.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")
.header("content-type", "application/json")
.body("{\"identifierValue\":\"string\",\"content\":{\"someBoolean\":true,\"someString\":\"Lorem ipsum\",\"aNestedDocument\":\"{% document exampleslug %}\"},\"params\":{\"property1\":\"string\",\"property2\":\"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: Documents
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.
```