Provisioning API Documentation¶
The Provisioning API provides possibilities to create and modify organizations.
You can download Postman collection with request examples.
Download Postman project
Authentication¶
All provisioning API calls are authenticated with a JWT, which is created analog to section Authentication.
iat
(Issued At), iss
(Issuer) and jti
(JWT ID) are required fields for the JWT payload.
The token is signed with the provisioning key
and passed as Bearer <JWT>
in the authorization
field of the headers.
The x-client-id
-field is not needed here, because the provisioning will affect the whole SMASHDOCs installation.
Important
The provisioning key for provisioning call is different from the partner API authentication credentials
Code example: JWT in Python
import jwt
import uuid
import datetime
# provided provisioning_key
provisioning_key = '32284ebdc5b8ea867058155b6ebcd7e0f9b0ed0ce2953b0451d9e6dbc9a68e70'
# user_id which issues the provisioning request
user_id = '5813099d5cb91899eea6da05'
jwt_payload = {
'iat': int(datetime.datetime.now().timestamp()),
'iss': user_id,
'jti': str(uuid.uuid4())
}
token = jwt.encode(payload=jwt_payload, key=provisioning_key, algorithm="HS256")
bearer_token = "Bearer {token}".format(token)
print(bearer_token)
Provisioning options¶
Create Organization¶
A new organization can be created via POST /provisioning/organization
.
The organization is initialised with the default smashdocs branding and without any word templates.
In the json request payload, two parameters can be passed:
name
is the organization’s name (required).replacement_url
is an url which is used to to make documents accessible via the partner system. This url must contain the string{doc_id}
(e.g.https://partner_url.com/smashdocs/sessions/{doc_id}
) which will be replaced with the SMASHDOCs document id. When this url is opened, the partner system has to check the users rights to that document, open the document via the partner api and redirect the user to thedocumentAccessUrl
via HTTP-302.add_default_word_template
is an optional boolean parameter which determines, whether the default word template is added to the newly created organization.
The response of the API call contains credentials that are necessary for further calls in the partner API and the organization id
.
Get Organizations¶
The info regarding all existing organizations can be fetched via GET /provisioning/organization
.
The response contains a list of objects with the following fields:
uuid
: Identifier for this organization objectname
: Organization namefeatures
: Information about enabled features and limitsword_templates
: List of word template objectsepub_templates
: List of epub template objectsindesign_templates
: List of indesign template objectsconversation_keys
: List of conversation type keys that are configured in this organizationresources
: List of uploaded in Minio container resource documentsword_import_mapping
: Configured mapping of paragraph decorators, inline styles with Word Doc Styles (import)samples
: List of sdox templates that can be used for new document creationparagraph_style_set
: List of configured the main formatting elements for the whole sectioninline_style_set
: List of configured formatting elements for section partsquick_start_menus
: List of customized images that act like quick access toolsdefault_settings
: Combination of different settings for organizationlogos
: List of logo images pathsbranding_text
: Title and subtitle texts intended to be shown on login pageconfigured_special_chars
: List of localised char codes that look as symbols in a documentjwt_auth
: comprise organization’s client secret and client id as sha256 hash
Validate credentials¶
Once an organization is created the client-id and client-secret credentials can be validated
In the json request payload, two parameters can be passed:
client-id
(required).client-secret
(required)
The response of the validation call will either return HTTP 200 or HTTP 404 if the credentials could not be validated
Word template - analyze¶
The first step of uploading word template is carried out via:
POST /provisioning/organization/{organization_id}/word/analyze/upload
Word template file is sent and response shows proposed mapping of system paragraph decorators with styles inside a word template file.
Successfull word template analyze returns HTTP 200
otherwise HTTP 404
Add a Word Template (optional)¶
The API call POST /provisioning/organization/{organization_id}/word/upload
gives the possibility to add a word
template to the organization. The organization id
has to be passed as path parameter.
In the Request Payload of type “multipart/form-data”, there are two fields:
file
contains the Word-template itself as docx-file.data
contains a json string with additional fields, which determinename
,description
andmapping
of the word template.
The id
, name
and description
of the new created word template are returned.
Hint
Please find a code example for multipart/form-data uploads here: api_guide.html#importing-word-documents
Update an existing Word Template (optional)¶
A word template can be updated via POST /provisioning/organization/{organization_id}/word/{template_id}/upload
.
This call works similar to the create word template call:
Additional is only the path parameter template_id
, the rest is the same.
The organization id
has to be passed as path parameter.
In the Request Payload of type “multipart/form-data”, there are two fields:
file
contains the Word-template itself as docx-file.data
contains a json string with additional fields, which determinename
,description
andmapping
of the word template.
The id
, name
and description
of the updated word template are returned.
Hint
Please find a code example for multipart/form-data uploads here: api_guide.html#importing-word-documents
Update an existing Word Template metadata (optional)¶
A word template metadata can be updated via POST /provisioning/organization/{organization_id}/word/{template_id}
.
The organization id
and template id
have to be passed as path parameters.
In the Request Payload of type “multipart/form-data”, there is one field:
data
contains a json string with additional fields, which determinename
anddescription
of the word template.
The id
, name
and description
of the updated word template are returned.
Upsert a conversation type in an organization¶
Inserting or updating a conversation type can be done with the api endpoint POST /provisioning/organization/<organization_id:uuid>/conversation-types/<conversation_type_key>
.
Path variables are the organization_id
and the conversation_type_key
.
The json request payload contains all data about the conversation type, which consists of:
translated name
metadata fields
option, whether resolved-functionality is enabled
list that determines, which field of the metadata is shown in the list of conversations in the document
A single metadata field consists of the information regarding:
human readable field key
translated name
translated tooltip text
- field type:
- text
height in lines
max length
default value: can be
empty
,clean_section
orredline_section
- dropdown
choices
default value
- checkbox
default value
roles that are required to view, create or update this field
is required field
is tracked field
changelog message if it is tracked field
is filter for conversation list
is filter for export
A detailed description of all keys and values is contained in the jsonschema-file dynamicConversationConfiguration.json
Сonversation type - get¶
Information about a certain conversation type in an organization can be fetched via
GET /provisioning/organization/<organization_id:uuid>/conversation-types/<key>
.
Fields of the response are described in the section Upsert a conversation type in an organization
Conversations configuration - get¶
Dynamic conversation configuration (DCC) can be obtained by means of:
GET /provisioning/conversations-configuration
.
Information about DCC fields can be found in descriptions and titles fields of example configuration.
Logos - upload and download¶
Replacing default images for the first page like email, favicon images etc.
is performed via:
POST /provisioning/organization/<organization_id:uuid>/image/upload
In the json request payload, one parameter is passed:
imageType
(required).
- There are 6 logo types:
branding_logo_url
,branding_logo_with_text_url
,email_logo_url
,favicon_url
,logo_url
,login_page_image
The response of image upload will return HTTP 201
or HTTP 400
It is possible to download an existing logo image. No API is used for this. Frontend saves a new file e.g. company_logo.png or ‘email_logo.png’ in browser’s folder for download.
Logos - deletion¶
If logo image is no more required, it can be deleted via:
DELETE /provisioning/organization/<organization_id:uuid>/logos/<logo_id:uuid>
.
If appears 405 METHOD NOT ALLOWED
more likely than not, logo file name has old
file name (not uuid). To make this endpoint work, just upload new image, it will
be saved with correct name and than it is possible to delete this logo.
Successfull logo deletion returns HTTP 204
Title and Subtitle on first page - upsert¶
When a user opens the first page of an application e.g. partner.smashdocs.net/global/login
by means of PC (might not be seen in cell phone) he sees something like this Smart word processing
How Word but 5x times faster. This text can be changed via:
POST /provisioning/organization/<organization_id:uuid>/branding-text
.
Endpoint is able to create, update and delete titles of first page.
Successfull titles change returns HTTP 201
otherwise HTTP 404
.
Word Import Mapping (1st step)¶
Current endpoint analyzes a sent word document and shows import mapping for paragraph decorators, inline styles etc.:
POST /provisioning/organization/<organization_id:uuid>/word-doc/analyze/upload
Response can be used for 2nd step.
Successfull upload returns HTTP 200
with mapping otherwise HTTP 404
.
Word Import Mapping (Import Set Up) - upsert and download (2nd step)¶
It configures styles correspondence between word document that will be imported in
editor and application. It is carried out with the help of:
POST /provisioning/organization/<organization_id:uuid>/word_import_mapping
Endpoint is able to create, update and delete word import mapping. Configuration is done through json file. To update configuration, currently frontend sends two request - the first one with empty values to clean existing data in db (template.word_import_mapping) and the second one with new word import mapping configuration.
Successfull word import mapping change returns HTTP 200
with current configuration in json
otherwise HTTP 404
.
It is possible to download an existing configuration. No API is used for this. Frontend saves a new file Import Set Up.json in browser’s download folder.
Sdox Template - download¶
In situation when sdox template is needed for other organization, it can be downloaded via:
GET /provisioning/organization/<organization_id:uuid>/sdox/<template_id:uuid>/download
Using API (not only frontend) is requred here because sdox temlate is stored in Minio docker container.
Successfull sdox template download returns HTTP 200
and saves
a new file sdox_template_<uuid>.sdox otherwise HTTP 404
.
Sdox Template - upload, update¶
It is possible to upload sdox template (binary file) via:
POST /provisioning/organization/<organization_id:uuid>/samples/<template_id:uuid>/upload
- Additional settings like:
name
(required),description
,pdSettings
,inlineStyleSubset
,exportSubset
In case updating an existing sdox template is carried out, sdox template is not required to be sent.
Successfull sdox template upload returns HTTP 201
with uploaded config in json
otherwise HTTP 404
.
Sdox Template - deletion¶
Cleaning application from old sdox templates is done by means of:
DELETE /provisioning/organization/<organization_id:uuid>/samples/<sample_id:uuid>
Successfull sdox template deletion returns HTTP 204
otherwise HTTP 404
.
Resource Document - upload¶
Initial document or other resource documents can be uploaded into Minio container through:
POST /provisioning/organization/<organization_id:uuid>/resources
Successfull resource document upload returns HTTP 201
with document id in json
otherwise:
HTTP 404
“No document uploaded.”
HTTP 412
“Document should be .sdox format.”
HTTP 412
“No such organization.”
HTTP 412
“Document is in the DB. NOT uploading …”
Resource Document - deletion¶
Initial document or other resource document can be deleted from Minio by using:
DELETE /provisioning/organization/<organization_id:uuid>/resources/<resource_id:uuid>
Successfull resource document deletion returns Resource was deleted. DOC_ID: {resource_id}.
.
Feature - setting¶
There are two types of organization’s features (special functionalities):
with number limit and enabled/disabled. They are configured through:
POST /provisioning/organization/<organization_id:uuid>/feature
Some features are activated by default, others can be purchased.
Successfull feature setting returns HTTP 200
with particular feature
current state in json otherwise HTTP 404
.
Features - get¶
In most cases all features are received with GET /provisioning/organization
but also features can be fetched directly via:
GET /provisioning/organization/feature
Successfull features fetch returns HTTP 200
with every feature current state.
Special characters - upsert¶
Different symbols like β, α, ≠ etc. can be configured with the help of:
POST /provisioning/organization/<organization_id:uuid>/special-characters
Successfull special characters setting returns HTTP 200
with {}
.
Citation Configuration - get¶
Different types of bibliographies’ elements - citations can be obtained via:
GET /provisioning/organization/<organization_id:uuid>/citation-config
Citation Configuration - upsert¶
Configuration of bibliographies’ citations is done through:
POST /provisioning/organization/<organization_id:uuid>/citation-config
Successfull save of citation configuration returns HTTP 200
with {}
.
Tag - upsert¶
Creates or updates organization’s tag that can be put to use in editor’s sections.
Tag configuration is sent over:
POST /provisioning/organization/<organization_id:uuid>/tags
Successfull tag upsert returns HTTP 200
otherwise - HTTP 404
.
Word template - download¶
If word template is needed for other organization, or some refactoring required,
it can be downloaded by means of:
GET /provisioning/organization/<organization_id:uuid>/word/<template_id:uuid>/download
Using API (not only frontend) is important here because word temlate is stored in Minio docker container.
Successfull word template download returns HTTP 200
and saves
a new file word_template_<uuid>.docx otherwise HTTP 404
.
Word template - deletion¶
If a word template is no more required, it can be deleted via:
POST /provisioning/organization/<organization_id:uuid>/word/<template_id:uuid>/delete
Successfull word template deletion returns HTTP 204
otherwise HTTP 404
.
Word template - duplication¶
It is possible to duplicate a word template with the help of:
POST /provisioning/organization/<organization_id:uuid>/word-template/<template_id:uuid>/duplicate
No additional parameters are required.
Successfull word template duplication returns HTTP 201
otherwise HTTP 404
.
Users - get¶
The list of Registered users with data can be obtained via:
POST /provisioning/organization/<organization_id:uuid>/users
- The following query parameters are allowed here:
status
(confirmed
,invited
,deleted
,inactive
orpending
),search
,is-internal
(true
orfalse
),system-role
,per-page
,page
search
users will be filtered by firstname, lastname, email and company.
is-internal
filters users by domain name in email.
Successfull obtaining of users returns HTTP 200
otherwise HTTP 403
.
User - create¶
New system user can be created by means of:
POST /provisioning/organization/<organization_id:uuid>/users
- The following fields are allowed in payload:
firstname
,lastname
,email
(required fields),systemRole
(normal_user
orsystem_admin
),invite
(true
orfalse
),settings
:lang
(required field for supported languages likede_DE
,en_EN
,es_ES
etc.),tooltips
(true
orfalse
),selection_autocomplete
(true
orfalse
),live_redline
(true
orfalse
),individual_decide
(true
orfalse
),debug_mode_transformations
(true
orfalse
),auto_collapse_pd_group
(true
orfalse
)
Successfull user creation returns HTTP 201
with user’s data in json.
User - update¶
Existing user can be update with the help of:
POST /provisioning/organization/<organization_id:uuid>/users/<user_id:uuid>
- The following fields are required in payload:
firstname
,lastname
,systemRole
(normal_user
orsystem_admin
),company
,status
(invited
,confirmed
orinactive
),settings
lang
Successfull user update returns HTTP 204
.
User - password reset¶
It is possible to reset user’s password through:
POST /provisioning/organization/<organization_id:uuid>/users/<user_id:uuid>/sendreset
Afterwards a user receives an email with a link like the following:
https://partner.smashdocs.net/global/resetpassword/5c2f98d277b30aca7760ca03570411b2d4?lang=en_EN
and after clicking on it, can change password.
Successfull password reset returns HTTP 200
otherwise HTTP 401
or HTTP 404
User - reinvite¶
If a user hasn’t received an invitation email for registration, this email
can be resent via: POST /provisioning/organization/<organization_id:uuid>/users/<user_id:uuid>/reinvite
User clicks on a link in email like below and finishes registration:
https://partner.smashdocs.net/global/register?confirmation-token=b3e741.dPLZ_kOUfpZoStdzL-UHs4QJLQs
Successfull reinvitation returns HTTP 200
otherwise HTTP 400
, HTTP 401
or HTTP 404
Paragraph Decorators (PD) - upsert¶
Configuration of text sections’ main formatting elements - paragraph decorators is
carried out with the help of:
POST /provisioning/organization/<organization_id:uuid>/paragraph_style_set
During upsert, the full configuration is sent, that is why this endpoint comprises creation, deletion and modification. Paragraph Decorators are very powerfull and their fields depend from each other, so before they are saved in database, their fields are thoroughly validated.
PD styles can be organized in groups and live in child_items
field or
be separate - without group.
Successfull upsert returns HTTP 200
otherwise HTTP 404
or
can occur different expected exception with HTTP 412
Cleanup Routines Configuration - upsert¶
Configuration of cleanup routines is done by means of:
POST /provisioning/organization/<organization_id:uuid>/cleanup_routines_configuration
Routines can perform some task e.g. delete unnecessary spaces from a document or replace multiple consecutive blank lines with one blank line depending on configuration.
Successfull upsert returns HTTP 200
otherwise HTTP 400
.
ParsX Mapping - upsert¶
New configuration of ParsX that is intended for EPUB is sent over the following endpoint:
POST /provisioning/organization/<organization_id:uuid>/parsx-mapping
Successfull upsert returns HTTP 200
otherwise HTTP 404
.
Default Editor Styles - upsert¶
This elements are the following section types: paragraph, basic, list1, heading1 etc.
Most of them are outdated because Paragraph Decorators can substitute
all functionality of default editor styles.
Anyway configuration of default editor styles is done through:
POST /provisioning/organization/<organization_id:uuid>/default-editor-styles
Successfull upsert returns HTTP 200
otherwise HTTP 404
, HTTP 412
.
Inline styles - upsert¶
If Paragraph Decorators make formatting for the entire section, inline styles intended for formatting of certain words.
POST /provisioning/organization/<organization_id:uuid>/inline-styles
Successfull upsert returns HTTP 200
otherwise HTTP 404
, HTTP 412
.
Export all word documents¶
Word templates can be exported by means of:
POST /provisioning/organization/<organization_id:uuid>/export_word_all_documents
Resulting zip
file is saved in tmp
folder of backend Docker container.
Required fields are template_id
and language
.
Successfull export returns HTTP 200
.
Xref Target Type Group - upsert¶
Upsert of group is carried out by means of:
POST /provisioning/organization/<organization_id:uuid>/xref-target-type-group
name
and key
are required parameters.
Successfull upsert returns HTTP 200
with all organization’s output
otherwise HTTP 404
.
Xref Target Type Group - deletion¶
Deletion is done with the help of:
DELETE /provisioning/organization/<organization_id:uuid>/xref-target-type-group
If key
with value is sent, only one group will be deleted.
If key is not specified (empty json), all available xref target type
groups are going to be deleted.
Successfull deletion returns HTTP 204
otherwise HTTP 404
.
Default Template Settings - setting¶
Default settings like default user language, paragraph decorator, conversation type etc. are configured via:
POST /provisioning/organization/<organization_id:uuid>/default-settings
Successfull setting returns HTTP 200
otherwise HTTP 404
.
Examples¶
POST /provisioning/organization¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"name": "myorganization",
"replacement_url": "https://smashdocs.myorganization.com/documents/{doc_id}"
}
RESPONSE:
{
"jwt_auth": {
"client_secret": "1199a4d4052c23d990a402f44c12a73d7db3f80c213380b3da67501cad64a211",
"client_id": "2fc28f3bdfa2e041f4674f485cfb0393e194ea9b012c1cdbaf62258ac641c62f"
},
"password_auth": {
"superuser_password": "eG5r^Nf@%G|0e/3*ep3}'|`(@,g{EBtu",
"superuser_email": "myorganization@smashdocs.net"
}
"id": "d39f9433-00b3-424b-b797-3e23c0d44d56"
}
GET /provisioning/organization¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization
METHOD: GET
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
[
{
"uuid": "d39f9433-00b3-424b-b797-3e23c0d44d56",
"name": "MyOrg Inc.",
"resources": [
{
"id": "d2ce183a-6170-41c1-9e58-21679fa41d13",
"filename": "test-doc"
}
],
"features": [
{
"name": "export_pdf",
"enabled": false
},
{
"name": "document_comparison",
"enabled": true
}
],
"word_templates": [
{
"id": "175c76d6-4647-4844-b190-f9a84fdccbdf",
"name": "STANDARD ALL STYLES\t",
"description": ""
}
],
"word_import_mapping": {
"paragraph": {
"heading 1": {
"paragraphDecoratorKey": "smartlist_1_heading_1",
"level": 0,
"textType": "paragraphDecorator"
},
"SD Table - Legend numbered": {
"paragraphDecoratorKey": "table_legend_numbered",
"level": 0,
"textType": "paragraphDecorator"
}
},
"inline": {
"Text_kleiner": "SD Inline - Text kleiner",
"hervorheben": "SD Inline - Hervorheben"
},
"numerated_list": [],
"bullet_list": []
},
"epub_templates": [],
"conversation_keys": [
"comment"
],
"samples": [
{
"id": "dfec26e2-9d2a-4129-946f-111439387226",
"name": "Einfache Liste",
"filename": "Einfache Liste",
"description": null,
"pdSettings": {
"pdSubset": [
"title_introduction",
"subtitle_introduction",
"list_1_simple_2",
"list_1_simple_1",
"list_1_simple_3"
],
"defaultPdKey": "text_1"
},
"inlineStyleSubset": [
"smaller",
"drafting_note",
"file"
],
"exportSubset": [
{
"type": html | html_all_in_one | word, pdf_cloudconvert | indesign_srz | xml_srz | indesign_pagina | files | pdf_srz | pdf_pagina | pdf_all_in_one | sdox | parsx_xml | epub | wordpress | annotationReport | images,
"templates": [
"7c919d7f-7447-403c-8ba3-e62a77949b22",
"f6298fb4-299a-4959-9e0d-969c7312037f",
"b01b8477-01aa-49fe-8cfb-3d3cb00fac1b"
]
},
],
}
],
"indesign_templates": [],
"paragraph_style_set": [
{
"item_type": "group",
"group_id": "3cda3aa8-1877-45e3-9c20-bc46db34d5c6",
"name": {
"de_DE": "Tabelle",
"en_EN": "Table"
},
"child_items": [
{
"item_type": "style",
"name": {
"de_DE": "Tabelle - Legende nummeriert",
"en_EN": "Table - legend numbered",
},
"key": "table_legend_numbered",
"show_in_editor_toc": false,
"section_types": [
"text"
],
"style_properties": {
"alignment": "justify"
},
"editor_style": "font-family:Helvetica; font-size:9pt; color:#000000; font-weight:normal; font-style:normal;",
"on_return_style_key": "table_legend_numbered",
"on_return_indentation": null,
"on_shift_tab_key": "text_1",
"on_tab_key": null,
"editor_toc_filter_level": null,
"editor_toc_indentation": null,
"bullet_list_format": null,
"numerated_list_format": "decimal",
"content_in_second_line": false,
"extra_hanging_indentation": null,
"extra_hanging_indentation_at_grid": true,
"initial_indentation": 0,
"is_fixed_indentation": true,
"list_key": "Table legend numbered 1",
"is_auto_restart_numbering": false,
"item_order": 0,
"allow_restart_numbering": true,
"numerated_list_start": null,
"item_order_allow_tab": true,
"numerated_list_pattern": "{0}",
"numerated_list_style": "",
"is_possible_xref_target": false,
"xref_target_type_group_key": "",
"keyboard_shortcut": {},
"backspace_action": "apply_other_pd",
"backspace_action_value": "text_1",
"hidden": false,
"create_new_section_on_return_if_empty": true,
"pd_for_new_section_on_return_if_empty": "text_1",
"change_pd_on_return_if_empty": true,
"pd_for_current_section_on_return_if_empty": "text_1",
"read_only": false,
"movable": true,
"content_required": false
}
],
"section_types": [
"text"
]
}
],
"inline_style_set": [
{
"name": {
"de_DE": "Kleiner",
"en_EN": "Smaller"
},
"key": "smaller",
"editor_style": "font-size:9pt;font-weight:normal;font-style:normal;text-decoration:none;",
"keyboard_shortcut": {}
],
"quick_start_menus": [
{
"sample_ids": [],
"key": "Introduction",
"icon": "",
"group_id": "0df1d332-ff17-4a84-b15c-5268f6a99bde"
}
],
"default_settings": {
"default_pd_key": "text_1",
"word_import_conversation_type": {
"conversation_type_key": "comment",
"field_name": "main_comment"
},
"default_user_language": "en_EN",
"default_scope": "all",
"internal_user_domains": [],
"projects_pd_restart_setting": false
},
"logos": {
"logo_url": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/8c1020ff-3c54-4a04-ac67-a96ef66def66.png",
"email_logo_url": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/b959f248-bd52-4b27-a751-d31b3e1c3778.png",
"branding_logo_with_text_url": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/21795bc1-b444-4a57-95d9-f860eeabb13b.png",
"branding_logo_url": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/7d1b3dc8-0c80-43dd-9509-24e0a98b64c9.png",
"favicon_url": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/7d1b3dc8-0c80-43dd-9509-24e0a98b64c9.png",
"login_page_image": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/06417877-78ca-40f3-bb08-65d29f9aeafa.jpg"
},
"connected_list_key_groups": [],
"branding_text": {
"login_page": {
"title": "<span>Smarte</span> Textverarbeitung",
"subtitle": "Wie Word. Nur viel <span>einfacher</span> und bis zu <span>5x schneller</span>."
}
},
"configured_special_chars": [
{
"name": "hyphens",
"title": {
"de_DE": "Trennstriche",
"en_EN": "Hyphens"
},
"characters": {
"#x2011": {
"name": "NON-BREAKING-HYPHEN"
},
"#x2014": {
"name": "EM-DASH"
}
}
}
],
"jwt_auth": {
"client_secret": "1199a4d4052c23d990a402f44c12a73d7db3f80c213380b3da67501cad64a211",
"client_id": "2fc28f3bdfa2e041f4674f485cfb0393e194ea9b012c1cdbaf62258ac641c62f"
}
}
]
POST /provisioning/validate¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/validate
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"client-id": "2fc28f3bdfa2e041f4674f485cfb0393e194ea9b012c1cdbaf62258ac641c62f",
"client-secret": "1199a4d4052c23d990a402f44c12a73d7db3f80c213380b3da67501cad64a211"
}
POST /provisioning/organization/{organization_id}/word/analyze/upload¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word/analyze/upload
METHOD: POST
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
"file":
<< DOCX - FILE >>
"data":
{
"name": "standard",
"description": "this is standard template"
}
RESPONSE:
{
"paragraphStyles": {
"mapping": {
"Image Caption": "Image Caption",
"Table Caption": "Table Caption",
"Table Heading": "SD Table - Heading",
"Table Text": "SD Table Text",
"Formula Caption": "Formula Caption",
"list_1_indented_1": "SD List (indented) 1-1",
"list_1_indented_2": "SD List (indented) 1-2",
"list_1_indented_3": "SD List (indented) 1-3"
},
"possibleValues": [
"SD Quote",
"SD Infobox 2 - Bullet",
"VSB Script",
"SD Drafting note - Heading"
]
},
"fixedCharacterStyles": {
"mapping": {
"crossref": null,
"weblink": "Hyperlink"
},
"possibleValues": [
"Fußnotentext Zchn",
"Überschrift 5 Zchn",
"Fußzeile Zchn",
"Überschrift 8 Zchn",
"SD inline - bigger",
"SD Inline - small capitals",
"Überschrift 3 Zchn"
]
},
"configuredCharacterStyles": {
"mapping": {},
"possibleValues": [
"Fußnotentext Zchn",
"Überschrift 5 Zchn",
"Fußzeile Zchn",
"Überschrift 3 Zchn"
]
},
"indentCmValues": [
0,
0,
0,
0,
0,
0
]
}
POST /provisioning/organization/{organization_id}/word/upload¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word/upload
METHOD: POST
Headers:
content-type: multipart/form-data
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI2MzEsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6ImI5ZDVhNjk5LWRkNzEtNGNlNi1iYjQwLTIzYjQ4ZjZjYmQ1ZSJ9.EIV11J1vQ1Cv0jWDbNr6d1N63ZCmvqMpZoPExu_TeI0
Payload:
"file":
<< DOCX - FILE >>
"data":
{
"name": "standard",
"description": "this is standard template",
"mapping": {"paragraphStyles":{"title":"Title","subtitle":"Subtitle"}, "fixedCharacterStyles":{"weblink":"Hyperlink"},"configuredCharacterStyles":{}}
}
RESPONSE:
{
"id": "75ab3ebf-ad60-44ec-87bf-1248c9568bf6",
"name": "standard",
"description": "this is standard template"
}
POST /provisioning/organization/{organization_id}/word/{template_id}/upload¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word/75ab3ebf-ad60-44ec-87bf-1248c9568bf6/upload
METHOD: POST
Headers:
content-type: multipart/form-data
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI3NTEsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjllZjZjNzQ0LTg1MTEtNGEzZi04YTkzLTE2NDhkMGVlNDgxYiJ9.o5HLHZWhZ8HQ2-PFW7BnraR6CWhuH0WrsdJVPd7ElRY
Payload:
"file":
<< DOCX - FILE >>
"data":
{
"name": "standard",
"description": "this is my changed description",
"mapping": {"paragraphStyles":{"title":"Title","subtitle":"Normal"}, "fixedCharacterStyles":{"weblink":"Hyperlink"},"configuredCharacterStyles":{}}
}
RESPONSE:
{
"id": "75ab3ebf-ad60-44ec-87bf-1248c9568bf6",
"name": "standard",
"description": "this is my changed description"
}
POST /provisioning/organization/{organization_id}/word/{template_id}¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word/75ab3ebf-ad60-44ec-87bf-1248c9568bf6
METHOD: POST
Headers:
content-type: multipart/form-data
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI3NTEsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjllZjZjNzQ0LTg1MTEtNGEzZi04YTkzLTE2NDhkMGVlNDgxYiJ9.o5HLHZWhZ8HQ2-PFW7BnraR6CWhuH0WrsdJVPd7ElRY
Payload:
"data":
{
"name": "standard",
"description": "this is my changed description without uploading a word file"
}
RESPONSE:
{
"id": "75ab3ebf-ad60-44ec-87bf-1248c9568bf6",
"name": "standard",
"description": "this is my changed description without uploading a word file"
}
POST /provisioning/organization/{organization_id}/conversation-types/{conversation_type_key}¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/conversation-types/comment
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI3NTEsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjllZjZjNzQ0LTg1MTEtNGEzZi04YTkzLTE2NDhkMGVlNDgxYiJ9.o5HLHZWhZ8HQ2-PFW7BnraR6CWhuH0WrsdJVPd7ElRY
Payload:
{
"display_key": [
"subject",
"description"
],
"fields": [
{
"editable_for": [
"ADMIN",
"creator"
],
"is_export_filter": false,
"is_list_filter": false,
"key": "subject",
"name": {
"de_DE": "Betreff",
"en_EN": "Subject"
},
"required_role_to_view": "reader",
"requirement_specific": {
"is_required_field": false,
"required_role_to_create": "commentator"
},
"tooltip_text": {
"de_DE": "Betreff hier eingeben (optional)",
"en_EN": "Type subject here (optional)"
},
"tracking_specific": {
"is_tracked_changes": true,
"stream_change_message": {
"de_DE": "{actorName} hat den Betreff geändert: {redline}",
"en_EN": "{actorName} has changed the subject: {redline}"
}
},
"type_specific": {
"default_value": "empty",
"field_type": "DynamicConversationTextfield",
"height_in_lines": 1,
"max_length": 1000,
"static_field": false
}
},
{
"editable_for": [],
"is_export_filter": false,
"is_list_filter": false,
"key": "description",
"name": {
"de_DE": "Beschreibung",
"en_EN": "Description"
},
"required_role_to_view": "reader",
"requirement_specific": {
"is_required_field": true,
"validation_error_message": {
"de_DE": "Beschreibung ist ein Pflichtfeld",
"en_EN": "Description is a mandatory field"
}
},
"tooltip_text": {
"de_DE": "Beschreibung hier eingeben",
"en_EN": "Type description here"
},
"tracking_specific": {
"is_tracked_changes": false
},
"type_specific": {
"default_value": "empty",
"field_type": "DynamicConversationTextfield",
"height_in_lines": 4,
"max_length": 1000,
"static_field": false
}
},
{
"editable_for": [
"ADMIN",
"approver"
],
"is_export_filter": false,
"is_list_filter": true,
"key": "priority",
"name": {
"de_DE": "Priorität",
"en_EN": "Priority"
},
"required_role_to_view": "approver",
"requirement_specific": {
"is_required_field": false,
"required_role_to_create": "approver"
},
"tooltip_text": {
"de_DE": "Priorität ist hier auswählbar",
"en_EN": "Priority is possible to be selected here"
},
"tracking_specific": {
"is_tracked_changes": true,
"stream_change_message": {
"de_DE": "{actorName} hat die Priorität von {oldValue} auf {newValue} gesetzt.",
"en_EN": "{actorName} has set the priority from {oldValue} to {newValue}."
}
},
"type_specific": {
"choices": [
"0",
"1",
"2"
],
"default_value": null,
"field_type": "DynamicConversationDropdown"
}
},
{
"editable_for": [
"ADMIN",
"approver"
],
"is_export_filter": true,
"is_list_filter": true,
"key": "urgent",
"name": {
"de_DE": "dringend",
"en_EN": "urgent"
},
"required_role_to_view": "reader",
"requirement_specific": {
"is_required_field": false,
"required_role_to_create": "approver"
},
"tooltip_text": {
"de_DE": "Klicken, um zu bestimmen, ob dieser Kommentar dringend ist",
"en_EN": "Click to determine whether this conversation is urgent"
},
"tracking_specific": {
"is_tracked_changes": true,
"stream_change_message": {
"de_DE": "{actorName} hat dringend auf {newValue} gesetzt.",
"en_EN": "{actorName} has set urgent to {newValue}."
}
},
"type_specific": {
"default_value": false,
"field_type": "DynamicConversationCheckbox"
}
}
],
"key": "comment",
"name": {
"de_DE": "Kommentar",
"en_EN": "Comment"
},
"show_resolved": true
}
RESPONSE:
status: 200
GET /provisioning/organization/{organization_id}/conversation-types/comment¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/conversation-types/comment
METHOD: GET
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
{
"display_key": [
"subject",
"description"
],
"show_resolved": true,
"name": {
"en_EN": "Comment",
"de_DE": "Kommentar"
},
"key": "comment",
"fields": [
{
"editable_for": [
"ADMIN",
"creator"
],
"required_role_to_view": "reader",
"requirement_specific": {
"is_required_field": false,
"required_role_to_create": "commentator"
},
"key": "subject",
"tracking_specific": {
"is_tracked_changes": true,
"stream_change_message": {
"en_EN": "{actorName} has changed the subject: {redline}",
"de_DE": "{actorName} hat den Betreff geändert: {redline}"
}
},
"type_specific": {
"default_value": "empty",
"height_in_lines": 1,
"max_length": 1000,
"field_type": "DynamicConversationTextfield",
"static_field": false
},
"name": {
"en_EN": "Subject",
"de_DE": "Betreff"
},
"is_list_filter": false,
"is_export_filter": false,
"tooltip_text": {
"en_EN": "Type subject here (optional)",
"de_DE": "Betreff hier eingeben (optional)"
}
},
{
"editable_for": [],
"required_role_to_view": "reader",
"requirement_specific": {
"is_required_field": true,
"validation_error_message": {
"en_EN": "Description is a mandatory field",
"de_DE": "Beschreibung ist ein Pflichtfeld"
}
},
"key": "description",
"tracking_specific": {
"is_tracked_changes": false
},
"type_specific": {
"default_value": "empty",
"height_in_lines": 4,
"max_length": 1000,
"field_type": "DynamicConversationTextfield",
"static_field": false
},
"name": {
"en_EN": "Description",
"de_DE": "Beschreibung"
},
"is_list_filter": false,
"is_export_filter": false,
"tooltip_text": {
"en_EN": "Type description here",
"de_DE": "Beschreibung hier eingeben"
}
},
{
"editable_for": [
"ADMIN",
"approver"
],
"required_role_to_view": "approver",
"requirement_specific": {
"is_required_field": false,
"required_role_to_create": "approver"
},
"key": "priority",
"tracking_specific": {
"is_tracked_changes": true,
"stream_change_message": {
"en_EN": "{actorName} has set the priority from {oldValue} to {newValue}.",
"de_DE": "{actorName} hat die Priorität von {oldValue} auf {newValue} gesetzt."
}
},
"type_specific": {
"default_value": null,
"choices": [
"0",
"1",
"2"
],
"field_type": "DynamicConversationDropdown"
},
"name": {
"en_EN": "Priority",
"de_DE": "Priorität"
},
"is_list_filter": true,
"is_export_filter": false,
"tooltip_text": {
"en_EN": "Priority is possible to be selected here",
"de_DE": "Priorität ist hier auswählbar"
}
},
{
"editable_for": [
"ADMIN",
"approver"
],
"required_role_to_view": "reader",
"requirement_specific": {
"is_required_field": false,
"required_role_to_create": "approver"
},
"key": "urgent",
"tracking_specific": {
"is_tracked_changes": true,
"stream_change_message": {
"en_EN": "{actorName} has set urgent to {newValue}.",
"de_DE": "{actorName} hat dringend auf {newValue} gesetzt."
}
},
"type_specific": {
"default_value": false,
"field_type": "DynamicConversationCheckbox"
},
"name": {
"en_EN": "urgent",
"de_DE": "dringend"
},
"is_list_filter": true,
"is_export_filter": true,
"tooltip_text": {
"en_EN": "Click to determine whether this conversation is urgent",
"de_DE": "Klicken, um zu bestimmen, ob dieser Kommentar dringend ist"
}
}
]
}
GET /provisioning/conversations-configuration¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/conversations-configuration
METHOD: GET
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
{
"additionalProperties": false,
"definitions": {
"additionalField": {
"additionalProperties": false,
"properties": {
"is_required_field": {
"enum": [
false
],
"options": {
"hidden": true
},
"type": "boolean"
},
"required_role_to_create": {
"allOf": [
{
"title": "Required Role for setting this field on creation."
},
{
"$ref": "#/definitions/allRolesFromCommentator"
}
]
}
},
"required": [
"is_required_field",
"required_role_to_create"
],
"title": "Additional Field",
"type": "object"
},
"allRoles": {
"default": "reader",
"enum": [
"ADMIN",
"approver",
"editor",
"commentator",
"reader"
],
"type": "string"
},
"allRolesFromCommentator": {
"default": "commentator",
"enum": [
"ADMIN",
"approver",
"editor",
"commentator"
],
"type": "string"
},
"checkboxSpecificFields": {
"additionalProperties": false,
"properties": {
"default_value": {
"title": "Default Value",
"type": "boolean"
},
"field_type": {
"enum": [
"DynamicConversationCheckbox"
],
"options": {
"hidden": true
},
"type": "string"
}
},
"required": [
"default_value",
"field_type"
],
"title": "Checkbox",
"type": "object"
},
"dropdownSpecificFields": {
"additionalProperties": false,
"properties": {
"choices": {
"format": "table",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"title": "Choices for Dropdown",
"type": "array",
"uniqueItems": true
},
"default_value": {
"oneOf": [
{
"minLength": 1,
"title": "String Value",
"type": "string"
},
{
"title": "Null Value",
"type": "null"
}
],
"title": "Default Value"
},
"field_type": {
"enum": [
"DynamicConversationDropdown"
],
"options": {
"hidden": true
},
"type": "string"
}
},
"required": [
"choices",
"default_value",
"field_type"
],
"title": "Dropdown",
"type": "object"
},
"dynamicConversationField": {
"additionalProperties": false,
"headerTemplate": "{{ i1 }} - {{ self.key }}",
"properties": {
"display_as_conversation": {
"default": false,
"description": "This checkbox determines, how this field is displayed in the Creation Message. The Creation Message shows the initial state of all fields at the top of the conversation. If chosen, this field will be shown in style of a user answer instead of grey small text.",
"format": "checkbox",
"title": "\"Display as conversation\"",
"type": "boolean"
},
"export_field_in_word": {
"default": true,
"format": "checkbox",
"title": "\"Export this field in the Word export\"",
"type": "boolean"
},
"editable_for": {
"default": [],
"items": {
"enum": [
"ADMIN",
"approver",
"editor",
"commentator",
"creator"
],
"type": "string"
},
"propertyOrder": 12,
"title": "Roles that are allowed to edit this field after the conversation is created.",
"type": "array",
"uniqueItems": true
},
"is_export_filter": {
"format": "checkbox",
"propertyOrder": 20,
"title": "Offer as filter for export",
"type": "boolean"
},
"is_list_filter": {
"format": "checkbox",
"propertyOrder": 21,
"title": "Offer as filter in conversation list",
"type": "boolean"
},
"key": {
"minLength": 1,
"pattern": "^[a-z_]+$",
"propertyOrder": 1,
"type": "string"
},
"name": {
"allOf": [
{
"propertyOrder": 2,
"title": "Name of Field"
},
{
"$ref": "#/definitions/requiredTranslatedField"
}
]
},
"required_role_to_view": {
"allOf": [
{
"propertyOrder": 10,
"title": "Required Role to view this field"
},
{
"$ref": "#/definitions/allRoles"
}
]
},
"requirement_specific": {
"oneOf": [
{
"$ref": "#/definitions/requiredField"
},
{
"$ref": "#/definitions/additionalField"
}
],
"propertyOrder": 30,
"title": "Requirement"
},
"tooltip_text": {
"allOf": [
{
"propertyOrder": 5,
"title": "Tooltip Text"
},
{
"$ref": "#/definitions/translatedField"
}
]
},
"tracking_specific": {
"oneOf": [
{
"$ref": "#/definitions/trackedField"
},
{
"$ref": "#/definitions/untrackedField"
}
],
"propertyOrder": 40,
"title": "Tracking of this field"
},
"type_specific": {
"format": "grid",
"oneOf": [
{
"$ref": "#/definitions/textboxSpecificFields"
},
{
"$ref": "#/definitions/dropdownSpecificFields"
},
{
"$ref": "#/definitions/checkboxSpecificFields"
}
],
"propertyOrder": 7,
"title": "Field Type"
}
},
"required": [
"display_as_conversation",
"export_field_in_word",
"editable_for",
"is_export_filter",
"is_list_filter",
"key",
"name",
"required_role_to_view",
"requirement_specific",
"tooltip_text",
"tracking_specific",
"type_specific"
],
"title": "Dynamic Conversation Field",
"type": "object"
},
"requiredField": {
"additionalProperties": false,
"properties": {
"is_required_field": {
"enum": [
true
],
"options": {
"hidden": true
},
"type": "boolean"
},
"validation_error_message": {
"allOf": [
{
"title": "Validation Error Message"
},
{
"$ref": "#/definitions/requiredTranslatedField"
}
]
}
},
"required": [
"is_required_field",
"validation_error_message"
],
"title": "Required Field",
"type": "object"
},
"requiredTranslatedField": {
"properties": {
"de_DE": {
"title": "German",
"minLength": 1,
"type": "string"
},
"en_EN": {
"title": "English",
"minLength": 1,
"type": "string"
}
},
"required": [
"de_DE",
"en_EN"
],
"type": "object"
},
"textboxSpecificFields": {
"additionalProperties": false,
"properties": {
"default_value": {
"enum": [
"empty",
"clean_section"
],
"title": "Default Value",
"type": "string"
},
"field_type": {
"enum": [
"DynamicConversationTextfield"
],
"options": {
"hidden": true
},
"type": "string"
},
"height_in_lines": {
"default": 1,
"minimum": 1,
"title": "Height in Lines",
"type": "integer"
},
"max_length": {
"default": 1000,
"minimum": 1,
"title": "Maximum length in chars",
"type": "integer"
},
"static_field": {
"default": false,
"description": "If chosen, the default value can not be changed at all, also not at creation.",
"format": "checkbox",
"title": "Static Field",
"type": "boolean"
}
},
"required": [
"default_value",
"field_type",
"height_in_lines",
"max_length",
"static_field"
],
"title": "Textfield",
"type": "object"
},
"trackedField": {
"additionalProperties": false,
"properties": {
"changelog_message_as_post": {
"default": false,
"description": "If chosen, the changelog message will be shown in style of a user answer instead of grey small text.",
"format": "checkbox",
"title": "Changelog Message as Post",
"type": "boolean"
},
"is_tracked_changes": {
"enum": [
true
],
"options": {
"hidden": true
},
"type": "boolean"
},
"stream_change_message": {
"description": "Can contain placeholders {actorName}, {oldValue}, {newValue}, {redline} (redline only for text field)",
"properties": {
"de_DE": {
"title": "German",
"pattern": "^([^\\{\\}]|\\{actorName\\}|\\{oldValue\\}|\\{newValue\\}|\\{redline\\})*$",
"minLength": 1,
"type": "string"
},
"en_EN": {
"title": "English",
"pattern": "^([^\\{\\}]|\\{actorName\\}|\\{oldValue\\}|\\{newValue\\}|\\{redline\\})*$",
"minLength": 1,
"type": "string"
}
},
"title": "Message for the log on change",
"type": "object"
}
},
"required": [
"changelog_message_as_post",
"is_tracked_changes",
"stream_change_message"
],
"title": "Tracked Field",
"type": "object"
},
"translatedField": {
"properties": {
"de_DE": {
"title": "German",
"type": "string"
},
"en_EN": {
"title": "English",
"type": "string"
}
},
"required": [
"de_DE",
"en_EN"
],
"type": "object"
},
"untrackedField": {
"additionalProperties": false,
"properties": {
"is_tracked_changes": {
"enum": [
false
],
"options": {
"hidden": true
},
"type": "boolean"
}
},
"required": [
"is_tracked_changes"
],
"title": "Untracked Field",
"type": "object"
}
},
"headerTemplate": "Dynamic Conversation Type - {{ self.key }}",
"properties": {
"display_key": {
"description": "List of field keys that determines the order in descending priority, which field is displayed in the conversation list.",
"format": "table",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"propertyOrder": 15,
"title": "Conversation List",
"type": "array",
"uniqueItems": true
},
"fields": {
"format": "tabs",
"items": {
"$ref": "#/definitions/dynamicConversationField"
},
"propertyOrder": 12,
"title": "Configured Fields for this Conversation",
"type": "array"
},
"key": {
"minLength": 1,
"options": {
"hidden": true
},
"propertyOrder": 7,
"title": "Key",
"type": "string"
},
"name": {
"allOf": [
{
"propertyOrder": 10,
"title": "Displayed Name of Conversation Type"
},
{
"$ref": "#/definitions/requiredTranslatedField"
}
]
},
"show_resolved": {
"default": true,
"format": "checkbox",
"propertyOrder": 16,
"title": "Show Resolved Button",
"type": "boolean"
},
"referenced_section_text_enabled": {
"default": true,
"format": "checkbox",
"propertyOrder": 17,
"title": "Referenced Section Text Functionality enabled",
"type": "boolean"
}
},
"required": [
"display_key",
"fields",
"key",
"name",
"referenced_section_text_enabled",
"show_resolved"
],
"type": "object"
}
POST /provisioning/organization/{organization_id}/image/upload¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/image/upload
METHOD: POST
Headers:
content-type: multipart/form-data;
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
"file":
<< Image - FILE >>
"data":
{
"imageType":"email_logo_url"
}
RESPONSE:
{
"logos": "/assets/public/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/44511990-6ee0-4d80-8acf-46cb9b309013.jpg"
}
DELETE /provisioning/organization/{organization_id}/logos/{logo_id}¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/logos/44511990-6ee0-4d80-8acf-46cb9b309013
METHOD: DELETE
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
status: 204
POST /provisioning/organization/{organization_id}/branding-text¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/branding-text
METHOD: POST
Headers:
content-type: application/json;
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload (Example 1 for create and update):
{
"login_page": {
"title": "New first page title",
"subtitle": "New first page subtitle"
}
}
Payload (Example 2 for delete):
{
"login_page": {
"title": "",
"subtitle": ""
}
}
RESPONSE (the same for all configs):
status: 201
POST /provisioning/organization/{organization_id}/word-doc/analyze/upload¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word-doc/analyze/upload
METHOD: POST
Headers:
content-type: multipart/form-data;
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
"file":
<< WORD - FILE >>
RESPONSE:
{
"paragraph": {
"Citation 1 - Heading": {
"textType": "paragraphDecorator",
"level": 0,
"paragraphDecoratorKey": "citation_heading"
},
"Subhead - Subtitle 1": {
"textType": "paragraphDecorator",
"level": 0,
"paragraphDecoratorKey": "subhead_1_subtitle"
},
"Table Caption": {
"textType": "caption"
},
"Title": {
"textType": "paragraphDecorator",
"level": 0,
"paragraphDecoratorKey": "title"
},
...
},
"inline": {
"Hyperlink": ""
}
}
POST /provisioning/organization/{organization_id}/word_import_mapping¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word_import_mapping
METHOD: POST
Headers:
content-type: application/json;
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload (Example 1 for create and update):
{
"paragraph": {
"heading 5": {
"paragraphDecoratorKey": "smartlist_1_heading_5",
"level": 3,
"textType": "paragraphDecorator"
},
"SD List - Dash 3": {
"paragraphDecoratorKey": "list_dash_3",
"level": 2,
"textType": "paragraphDecorator"
},
"SD Bibliography 1": {
"paragraphDecoratorKey": "bibliography",
"level": 0,
"textType": "paragraphDecorator"
},
"SD Joker 3": {
"paragraphDecoratorKey": "joker_3",
"level": 0,
"textType": "paragraphDecorator"
},
"SD Quote - Author": {
"paragraphDecoratorKey": "quote_subtitle",
"level": 0,
"textType": "paragraphDecorator"
},
"Title": {
"paragraphDecoratorKey": "title_introduction",
"level": 0,
"textType": "paragraphDecorator"
},
"Bullet point 5": {
"paragraphDecoratorKey": "list_bullet_5",
"level": 0,
"textType": "paragraphDecorator"
}
},
"numerated_list": [
"list_1_simple_1",
"list_1_simple_2",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3"
]
}
RESPONSE (Example 1 for create and update):
{
"paragraph": {
"heading 5": {
"paragraphDecoratorKey": "smartlist_1_heading_5",
"level": 3,
"textType": "paragraphDecorator"
},
"SD List - Dash 3": {
"paragraphDecoratorKey": "list_dash_3",
"level": 2,
"textType": "paragraphDecorator"
},
"SD Bibliography 1": {
"paragraphDecoratorKey": "bibliography",
"level": 0,
"textType": "paragraphDecorator"
},
"SD Joker 3": {
"paragraphDecoratorKey": "joker_3",
"level": 0,
"textType": "paragraphDecorator"
},
"SD Quote - Author": {
"paragraphDecoratorKey": "quote_subtitle",
"level": 0,
"textType": "paragraphDecorator"
},
"Title": {
"paragraphDecoratorKey": "title_introduction",
"level": 0,
"textType": "paragraphDecorator"
},
"Bullet point 5": {
"paragraphDecoratorKey": "list_bullet_5",
"level": 0,
"textType": "paragraphDecorator"
}
},
"inline": {},
"numerated_list": [
"list_1_simple_1",
"list_1_simple_2",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3"
],
"bullet_list": []
}
Payload (Example 2 for delete):
{
"paragraph": {
"heading 5": {},
"SD List - Dash 3": {},
"SD Bibliography 1": {},
"SD Joker 3": {},
"SD Quote - Author": {},
"Title": {},
"Bullet point 5": {}
},
"inline": {},
"numerated_list": [
"list_1_simple_1",
"list_1_simple_2",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3"
],
"bullet_list": []
}
RESPONSE (Example 2 for delete):
{
"paragraph": {},
"inline": {},
"numerated_list": [
"list_1_simple_1",
"list_1_simple_2",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3",
"list_1_simple_3"
],
"bullet_list": []
}
GET /provisioning/organization/{organization_id}/sdox/{sample_id}/download¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/sdox/77f88fd4-9d86-4406-9bd1-58eebbb2e402/download
METHOD: GET
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
file: sdox_template_a15e8b69-4bc0-4a85-bae1-8c5ef86391db.sdox
POST /provisioning/organization/{organization_id}/samples/{sample_id}/upload¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/samples/77f88fd4-9d86-4406-9bd1-58eebbb2e402/upload
METHOD: POST
Headers:
content-type: multipart/form-data;
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
"file":
<< SDOX - FILE >>
"data":
{
"name": "Video Storyboard",
"description": null,
"pdSettings": {
"pdSubset": [
"vsb_scene_l_1_video_storyboard",
"vsb_scene_l_2_video_storyboard",
"vsb_duration_video_storyboard",
"vsb_note_video_storyboard",
"smashdocs_vsb_script",
"quick_text_0",
"quick_text_1",
"quick_text_2",
"quick_text_3",
"quick_text_4",
"quick_text_5"
],
"defaultPdKey": "smashdocs_vsb_script"
},
"inlineStyleSubset": [
"smaller",
"drafting_note",
"file"
],
"exportSubset": [
{
"type": html | html_all_in_one | word, pdf_cloudconvert | indesign_srz | xml_srz | indesign_pagina | files | pdf_srz | pdf_pagina | pdf_all_in_one | sdox | parsx_xml | epub | wordpress | annotationReport | images,
"templates": [
"7c919d7f-7447-403c-8ba3-e62a77949b22",
"f6298fb4-299a-4959-9e0d-969c7312037f",
"b01b8477-01aa-49fe-8cfb-3d3cb00fac1b"
]
},
],
}
RESPONSE:
{
"id": "a15e8b69-4bc0-4a85-bae1-8c5ef86391db",
"name": "Video Storyboard",
"filename": "Template StoryBoard for Video",
"description": null,
"pdSettings": {
"pdSubset": [
"vsb_scene_l_1_video_storyboard",
"vsb_scene_l_2_video_storyboard",
"vsb_duration_video_storyboard",
"vsb_note_video_storyboard",
"smashdocs_vsb_script",
"quick_text_0",
"quick_text_1",
"quick_text_2",
"quick_text_3",
"quick_text_4",
"quick_text_5"
],
"defaultPdKey": "smashdocs_vsb_script"
},
"inlineStyleSubset": [
"smaller",
"drafting_note",
"file"
],
"exportSubset": [
{
"type": html | html_all_in_one | word, pdf_cloudconvert | indesign_srz | xml_srz | indesign_pagina | files | pdf_srz | pdf_pagina | pdf_all_in_one | sdox | parsx_xml | epub | wordpress | annotationReport | images,
"templates": [
"7c919d7f-7447-403c-8ba3-e62a77949b22",
"f6298fb4-299a-4959-9e0d-969c7312037f",
"b01b8477-01aa-49fe-8cfb-3d3cb00fac1b"
]
},
],
}
DELETE /provisioning/organization/{organization_id}/samples/{sample_id}¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/samples/77f88fd4-9d86-4406-9bd1-58eebbb2e402
METHOD: DELETE
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
status: 204
POST /provisioning/organization/{organization_id}/resources¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/resources
METHOD: POST
Headers:
content-type: multipart/form-data;
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
"file":
<< SDOX - FILE >>
"initial_doc": "d2ce183a-6170-41c1-9e58-21679fa41d13"
RESPONSE:
{
"id": "d2ce183a-6170-41c1-9e58-21679fa41d13"
}
DELETE /provisioning/organization/{organization_id}/resources/{resource_id}¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/resources/d2ce183a-6170-41c1-9e58-21679fa41d13
METHOD: DELETE
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
Resource was deleted. DOC_ID: d2ce183a-6170-41c1-9e58-21679fa41d13.
POST /provisioning/organization/{organization_id}/feature¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/feature
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI3NTEsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjllZjZjNzQ0LTg1MTEtNGEzZi04YTkzLTE2NDhkMGVlNDgxYiJ9.o5HLHZWhZ8HQ2-PFW7BnraR6CWhuH0WrsdJVPd7ElRY
Payload (example 1 for feature enabling):
{
"name": "bibliography",
"enabled": true
}
RESPONSE (example 1):
{
"name": "bibliography",
"enabled": true
}
Payload (example 2 for feature limiting):
{
"name":"internal_users_limit",
"limit":18
}
RESPONSE (example 2):
{
"name":"internal_users_limit",
"limit":18
}
GET /provisioning/feature¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/feature
METHOD: GET
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
{
"feature_names": [
{
"name": "documents_per_organization",
"type": "number"
},
{
"name": "section_history_limit",
"type": "number"
},
{
"name": "all_users_limit",
"type": "null"
},
{
"name": "internal_users_limit",
"type": "null"
},
{
"name": "snapshots",
"type": "boolean"
},
{
"name": "welcome_email",
"type": "boolean"
},
{
"name": "oauth2_server",
"type": "boolean"
},
...
]
}
POST /provisioning/organization/{organization_id}/special-characters¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/special-characters
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"config": [
{
"name": "math",
"title": {
"de_DE": "Mathematische Zeichen",
"en_EN": "Mathematical characters"
},
"characters": {
"#x2212": {
"name": "MINUS SIGN"
},
"#x003D": {
"name": "EQUALS SIGN"
},
"#x2260": {
"name": "NOT EQUAL TO"
},
"#x2265": {
"name": "GREATER-THAN OR EQUAL TO"
},
"#x2264": {
"name": "LESS-THAN OR EQUAL TO"
}
}
},
{
"name": "letters",
"title": {
"de_DE": "Buchstaben",
"en_EN": "Letters"
},
"characters": {
"#x00C7": {
"name": "LATIN CAPITAL LETTER C WITH CEDILLA"
},
"#x00E7": {
"name": "LATIN SMALL LETTER C WITH CEDILLA"
},
"#x00D1": {
"name": "LATIN CAPITAL LETTER N WITH TILDE"
}
}
}
]
}
RESPONSE:
{}
GET /provisioning/organization/{organization_id}/citation-config¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/citation-config
METHOD: GET
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
{
"bibliography": {
"citationTypes": [
{
"key": "article",
"title": {
"de_DE": "Article",
"en_EN": "Article",
"fr_CA": "Article",
"ru_RU": "Article"
},
"fields": [
"abstract",
"author",
"address",
"year",
"title",
"issn",
"pages",
"volume",
"keywords",
"journal",
"number",
"url",
"type",
"doi",
"month",
"note"
]
},
{
"key": "book",
"title": {
"de_DE": "Book",
"en_EN": "Book",
"fr_CA": "Book",
"ru_RU": "Book"
},
"fields": [
"abstract",
"author",
"author-company",
"year",
"date-year",
"title",
"title - short title",
"url",
"address",
"number of volumes",
"volume",
"publisher",
"publishing house",
"isbn",
"series",
"institution",
"keywords",
"comments",
"pages",
"translator",
"edition",
"editor",
"price",
"number",
"month",
"note",
"type",
"doi"
]
},
{
"key": "inproceedings",
"title": {
"de_DE": "Inproceedings",
"en_EN": "Inproceedings",
"fr_CA": "Inproceedings",
"ru_RU": "Inproceedings"
},
"fields": [
"author",
"year",
"title",
"url",
"urldate",
"address",
"publisher",
"isbn",
"volume",
"series",
"editor",
"pages",
"booktitle",
"month",
"organization",
"note",
"number",
"doi"
]
}
],
"fieldTitles": {
"author": {
"de_DE": "Author (s)",
"en_EN": "Author (s)",
"fr_CA": "Author (s)",
"ru_RU": "Author (s)"
},
"author-company": {
"de_DE": "Author - company",
"en_EN": "Author - company",
"fr_CA": "Author - company",
"ru_RU": "Author - company"
},
"title": {
"de_DE": "Title",
"en_EN": "Title",
"fr_CA": "Title",
"ru_RU": "Title"
},
"title - short title": {
"de_DE": "Title - short title",
"en_EN": "Title - short title",
"fr_CA": "Title - short title",
"ru_RU": "Title - short title"
},
"volume": {
"de_DE": "Volume",
"en_EN": "Volume",
"fr_CA": "Volume",
"ru_RU": "Volume"
}
},
"citationStyles": [
{
"key": "chicago",
"title": {
"de_DE": "Chicago",
"en_EN": "Chicago",
"fr_CA": "Chicago",
"ru_RU": "Chicago"
},
"short": "[{{number}}]",
"bibliography": "{{author}}, “{{title}}“, {{journal}}. {{year}}."
},
{
"key": "ieee",
"title": {
"de_DE": "IEEE",
"en_EN": "IEEE",
"fr_CA": "IEEE",
"ru_RU": "IEEE"
},
"short": "[E{{number}}]",
"bibliography": "{{author}}, “{{title}}“, {{journal}}. {{year}}."
},
{
"key": "apa",
"title": {
"de_DE": "APA",
"en_EN": "APA",
"fr_CA": "APA",
"ru_RU": "APA"
},
"short": "[{{number}}]",
"bibliography": "{{author}}, “{{title}}“, {{journal}}. {{year}}."
}
]
}
}
POST /provisioning/organization/{organization_id}/citation-config¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/citation-config
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"bibliography": {
"citationTypes": [
{
"key": "article",
"title": {
"de_DE": "Article",
"en_EN": "Article",
"fr_CA": "Article",
"ru_RU": "Article"
},
"fields": [
"abstract",
"author",
"address",
"year",
"title",
"issn",
"pages",
"volume",
"keywords",
"journal",
"number",
"url",
"type",
"doi",
"month",
"note"
]
},
{
"key": "book",
"title": {
"de_DE": "Book",
"en_EN": "Book",
"fr_CA": "Book",
"ru_RU": "Book"
},
"fields": [
"abstract",
"author",
"author-company",
"year",
"date-year",
"title",
"title - short title",
"url",
"address",
"number of volumes",
"volume",
"publisher",
"publishing house",
"isbn",
"series",
"institution",
"keywords",
"doi"
]
}
],
"fieldTitles": {
"author": {
"de_DE": "Author (s)",
"en_EN": "Author (s)",
"fr_CA": "Author (s)",
"ru_RU": "Author (s)"
},
"author-company": {
"de_DE": "Author - company",
"en_EN": "Author - company",
"fr_CA": "Author - company",
"ru_RU": "Author - company"
},
"title": {
"de_DE": "Title",
"en_EN": "Title",
"fr_CA": "Title",
"ru_RU": "Title"
}
},
"citationStyles": [
{
"key": "chicago",
"title": {
"de_DE": "Chicago",
"en_EN": "Chicago",
"fr_CA": "Chicago",
"ru_RU": "Chicago"
},
"short": "[{{number}}]",
"bibliography": "{{author}}, “{{title}}“, {{journal}}. {{year}}."
},
{
"key": "ieee",
"title": {
"de_DE": "IEEE",
"en_EN": "IEEE",
"fr_CA": "IEEE",
"ru_RU": "IEEE"
},
"short": "[E{{number}}]",
"bibliography": "{{author}}, “{{title}}“, {{journal}}. {{year}}."
}
]
}
}
RESPONSE:
{}
GET /provisioning/organization/{organization_id}/word/{template_id}/download¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word/77f88fd4-9d86-4406-9bd1-58eebbb2e402/download
METHOD: GET
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
file: word_template_175c76d6-4647-4844-b190-f9a84fdccbdf.docx
POST /provisioning/organization/{organization_id}/word/{template_id}/delete¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word/77f88fd4-9d86-4406-9bd1-58eebbb2e402/delete
METHOD: POST
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
status: 204
POST /provisioning/organization/{organization_id}/word-template/{template_id}/duplicate¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/word-template/77f88fd4-9d86-4406-9bd1-58eebbb2e402/duplicate
METHOD: POST
Headers:
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
status: 201
GET /provisioning/organization/{organization_id}/users¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/users?page=1&per-page=50&search=Tina
METHOD: GET
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
{
"users": [
{
"settings": {
"lang": "en_EN"
},
"email": "tina@smashdocs.net",
"systemRole": "normal_user",
"firstname": "Tina",
"lastname": "Grace",
"company": null,
"isInternal": false,
"status": "invited",
"id": "00dcf354-6af3-46cc-a606-ecbd08b48d52",
"registration_date": "2019.10.10"
},
{
"settings": {
"lang": "en_EN"
},
"email": "martina.sander@gmail.com",
"systemRole": "normal_user",
"firstname": "Martina",
"lastname": "Sander",
"company": null,
"isInternal": false,
"status": "invited",
"id": "74b6255a-4b8c-40e0-92d2-7a419b2c6c55",
"registration_date": "2019.12.16"
}
],
"users_number": 2
}
POST /provisioning/organization/{organization_id}/users¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/users
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"settings": {
"lang": "en_EN"
},
"email": "tina@smashdocs.net",
"systemRole": "system_admin",
"firstname": "Tina",
"lastname": "Grace",
"company": "Smartworks"
}
RESPONSE:
{
"settings": {
"lang": "en_EN"
},
"email": "tina@smashdocs.net",
"systemRole": "system_admin",
"firstname": "Tina",
"lastname": "Grace",
"company": "Smartworks",
"isInternal": false,
"status": "not_yet_invited",
"id": "678634b8-d160-4711-a4fd-7f1404770d09",
"registration_date": "2020.03.09"
}
POST /provisioning/organization/{organization_id}/users/{user_id}¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/users/d2ce183a-6170-41c1-9e58-21679fa41d13
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"settings": {
"lang": "en_EN"
},
"email": "tina@smashdocs.net",
"systemRole": "system_admin",
"firstname": "Tina",
"lastname": "Grace",
"company": "smashdocs",
"isInternal": false,
"status": "confirmed",
"id": "d2ce183a-6170-41c1-9e58-21679fa41d13",
"registration_date": "2019.04.12"
}
RESPONSE:
status: 204
POST /provisioning/organization/{organization_id}/users/{user_id}/sendreset¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/users/d2ce183a-6170-41c1-9e58-21679fa41d13/sendreset
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
status: 200
POST /provisioning/organization/{organization_id}/users/{user_id}/reinvite¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/users/d2ce183a-6170-41c1-9e58-21679fa41d13/reinvite
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
RESPONSE:
status: 201
POST /provisioning/organization/{organization_id}/paragraph_style_set¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/paragraph_style_set
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"item_type": "group",
"group_id": "dda5b20c-5166-4880-acfc-537b7f210fe7",
"group_key": null,
"name": {
"de_DE": "Schriftsatz - Überschriften",
"en_EN": "Court statement - Headings",
"ru_RU": ""
},
"child_items": [
{
"item_type": "style",
"name": {
"de_DE": "Schriftsatz - H1",
"en_EN": "Court Statement - H1",
"ru_RU": ""
},
"key": "court_statement_h_1",
"show_in_editor_toc": false,
"section_types": [
"text"
],
"style_properties": {
"alignment": "left"
},
"editor_style": "font-family:Times New Roman; font-size:12pt; color:#000000; font-weight:bold; margin-top:24pt; margin-bottom:6pt; line-height:1.5;",
"on_return_style_key": "court_statement_text_2",
"on_return_indentation": null,
"on_shift_tab_key": "court_statement_text_1",
"on_tab_key": "court_statement_h_2",
"editor_toc_filter_level": null,
"editor_toc_indentation": null,
"bullet_list_format": null,
"numerated_list_format": "upper-alpha",
"content_in_second_line": false,
"extra_hanging_indentation": null,
"extra_hanging_indentation_at_grid": true,
"initial_indentation": 0,
"is_fixed_indentation": true,
"list_key": "Court Statement Headings",
"is_auto_restart_numbering": false,
"item_order": 0,
"allow_restart_numbering": true,
"numerated_list_start": null,
"item_order_allow_tab": false,
"numerated_list_pattern": "{0}",
"numerated_list_style": "font-family:Helvetica; text-align:center; color:#FFFFFF; background-color:#1E88E5; min-width:20pt; border-radius:10pt;",
"is_possible_xref_target": true,
"xref_target_type_group_key": "Court statement",
"keyboard_shortcut": {},
"backspace_action": "apply_other_pd",
"backspace_action_value": "court_statement_text_2",
"hidden": false,
"create_new_section_on_return_if_empty": true,
"pd_for_new_section_on_return_if_empty": "court_statement_text_1",
"change_pd_on_return_if_empty": false,
"pd_for_current_section_on_return_if_empty": null,
"read_only": false,
"movable": true,
"content_required": false
},
{
"item_type": "style",
"name": {
"de_DE": "Schriftsatz - H2",
"en_EN": "Court Statement - H2",
"ru_RU": ""
},
"key": "court_statement_h_2",
"show_in_editor_toc": false,
"section_types": [
"text"
],
"style_properties": {
"alignment": "left"
},
"editor_style": "font-family:Times New Roman; font-size:12pt; color:#000000; font-weight:bold; margin-top:12pt; margin-bottom:6pt; line-height:1.5;",
"on_return_style_key": "court_statement_text_2",
"on_return_indentation": null,
"on_shift_tab_key": "court_statement_h_1",
"on_tab_key": "court_statement_h_3",
"editor_toc_filter_level": null,
"editor_toc_indentation": null,
"bullet_list_format": null,
"numerated_list_format": "upper-roman",
"content_in_second_line": false,
"extra_hanging_indentation": null,
"extra_hanging_indentation_at_grid": true,
"initial_indentation": 0,
"is_fixed_indentation": true,
"list_key": "Court Statement Headings",
"is_auto_restart_numbering": false,
"item_order": 1,
"allow_restart_numbering": false,
"numerated_list_start": null,
"item_order_allow_tab": false,
"numerated_list_pattern": "{1}.",
"numerated_list_style": "",
"is_possible_xref_target": true,
"xref_target_type_group_key": "Court statement",
"keyboard_shortcut": {},
"backspace_action": "apply_other_pd",
"backspace_action_value": "court_statement_text_2",
"hidden": false,
"create_new_section_on_return_if_empty": true,
"pd_for_new_section_on_return_if_empty": "court_statement_text_1",
"change_pd_on_return_if_empty": false,
"pd_for_current_section_on_return_if_empty": null,
"read_only": false,
"movable": true,
"content_required": false
}
]
}
RESPONSE:
{
"item_type": "group",
"group_id": "dda5b20c-5166-4880-acfc-537b7f210fe7",
"group_key": null,
"name": {
"de_DE": "Schriftsatz - Überschriften",
"en_EN": "Court statement - Headings",
"ru_RU": ""
},
"child_items": [
{
"item_type": "style",
"name": {
"de_DE": "Schriftsatz - H1",
"en_EN": "Court Statement - H1",
"ru_RU": ""
},
"key": "court_statement_h_1",
"show_in_editor_toc": false,
"section_types": [
"text"
],
"style_properties": {
"alignment": "left"
},
"editor_style": "font-family:Times New Roman; font-size:12pt; color:#000000; font-weight:bold; margin-top:24pt; margin-bottom:6pt; line-height:1.5;",
"on_return_style_key": "court_statement_text_2",
"on_return_indentation": null,
"on_shift_tab_key": "court_statement_text_1",
"on_tab_key": "court_statement_h_2",
"editor_toc_filter_level": null,
"editor_toc_indentation": null,
"bullet_list_format": null,
"numerated_list_format": "upper-alpha",
"content_in_second_line": false,
"extra_hanging_indentation": null,
"extra_hanging_indentation_at_grid": true,
"initial_indentation": 0,
"is_fixed_indentation": true,
"list_key": "Court Statement Headings",
"is_auto_restart_numbering": false,
"item_order": 0,
"allow_restart_numbering": true,
"numerated_list_start": null,
"item_order_allow_tab": false,
"numerated_list_pattern": "{0}",
"numerated_list_style": "font-family:Helvetica; text-align:center; color:#FFFFFF; background-color:#1E88E5; min-width:20pt; border-radius:10pt;",
"is_possible_xref_target": true,
"xref_target_type_group_key": "Court statement",
"keyboard_shortcut": {},
"backspace_action": "apply_other_pd",
"backspace_action_value": "court_statement_text_2",
"hidden": false,
"create_new_section_on_return_if_empty": true,
"pd_for_new_section_on_return_if_empty": "court_statement_text_1",
"change_pd_on_return_if_empty": false,
"pd_for_current_section_on_return_if_empty": null,
"read_only": false,
"movable": true,
"content_required": false
},
{
"item_type": "style",
"name": {
"de_DE": "Schriftsatz - H2",
"en_EN": "Court Statement - H2",
"ru_RU": ""
},
"key": "court_statement_h_2",
"show_in_editor_toc": false,
"section_types": [
"text"
],
"style_properties": {
"alignment": "left"
},
"editor_style": "font-family:Times New Roman; font-size:12pt; color:#000000; font-weight:bold; margin-top:12pt; margin-bottom:6pt; line-height:1.5;",
"on_return_style_key": "court_statement_text_2",
"on_return_indentation": null,
"on_shift_tab_key": "court_statement_h_1",
"on_tab_key": "court_statement_h_3",
"editor_toc_filter_level": null,
"editor_toc_indentation": null,
"bullet_list_format": null,
"numerated_list_format": "upper-roman",
"content_in_second_line": false,
"extra_hanging_indentation": null,
"extra_hanging_indentation_at_grid": true,
"initial_indentation": 0,
"is_fixed_indentation": true,
"list_key": "Court Statement Headings",
"is_auto_restart_numbering": false,
"item_order": 1,
"allow_restart_numbering": false,
"numerated_list_start": null,
"item_order_allow_tab": false,
"numerated_list_pattern": "{1}.",
"numerated_list_style": "",
"is_possible_xref_target": true,
"xref_target_type_group_key": "Court statement",
"keyboard_shortcut": {},
"backspace_action": "apply_other_pd",
"backspace_action_value": "court_statement_text_2",
"hidden": false,
"create_new_section_on_return_if_empty": true,
"pd_for_new_section_on_return_if_empty": "court_statement_text_1",
"change_pd_on_return_if_empty": false,
"pd_for_current_section_on_return_if_empty": null,
"read_only": false,
"movable": true,
"content_required": false
}
]
}
POST /provisioning/organization/{organization_id}/cleanup_routines_configuration¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/cleanup_routines_configuration
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"configured_cleanup_routines": [
{
"key": "REPLACE_BLANK_LINES",
"type": "routine",
"name": {
"de_DE": "Mehrfach aufeinander folgende Leerzeilen durch eine Leerzeile ersetzen",
"en_EN": "Replace multiple consecutive blank lines with one blank line"
},
"actions": [
{
"searchRegEx": "",
"replaceRule": {
"type": "removeEmptySection",
"value": {
"limitInRow": 1
}
}
}
]
},
{
"key": "DELETE_UNNECESSARY_SPACES",
"type": "routine",
"name": {
"de_DE": "Überflüssige Leerzeichen löschen",
"en_EN": "Delete unnecessary spaces"
},
"actions": [
{
"searchRegEx": "\\x{0020}\\x{0020}+",
"replaceRule": {
"type": "replace",
"value": " "
}
}
]
}
]
}
RESPONSE:
status: 200
POST /provisioning/organization/{organization_id}/parsx-mapping¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/parsx-mapping
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"mapping": "<styleMap><meta><publisher doctype=\"pagina.dtd\" imprint=\"PAG\"/></meta><sectionStyles/><inlineStyles/><inlineElements/></styleMap>"
}
RESPONSE:
status: 200
POST /provisioning/organization/{organization_id}/default-editor-styles¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/default-editor-styles
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
[
{
"key": "basic",
"style": "font-family:Noto Sans;"
}
]
RESPONSE:
status: 200
POST /provisioning/organization/{organization_id}/inline-styles¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/inline-styles
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
[
{
"name": {
"en_EN": "Highlighting",
"de_DE": "Hervorheben"
},
"key": "highlighting",
"keyboard_shortcut": {},
"editor_style": "font-weight:normal; font-style:normal; background-color:#FFCC80; text-decoration:none; text-transform:none; font-variant:normal; :undefined;"
}
]
RESPONSE:
[
{
"name": {
"de_DE": "Hervorheben",
"en_EN": "Highlighting"
},
"key": "highlighting",
"editor_style": "font-weight:normal; font-style:normal; background-color:#FFCC80; text-decoration:none; text-transform:none; font-variant:normal; :undefined;",
"keyboard_shortcut": {}
}
]
POST /provisioning/organization/{organization_id}/export_word_all_documents¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/export_word_all_documents
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"template_id": "527a85b4-7057-4bff-89be-f753bc5715b1",
"language": "en_EN"
}
RESPONSE:
/tmp/export_2020_4_16_5dc0a2a7-ce19-45e3-834d-b40764d324cf/all_documents.zip
POST /provisioning/organization/{organization_id}/xref-target-type-group¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/xref-target-type-group
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"name": {
"en_EN": "Court statement",
"de_DE": "",
},
"key": "Courtstatement"
}
RESPONSE:
{
...
"xref_target_type_groups": [
{
"key": "Courtstatement",
"name": {
"en_EN": "Court statement",
"de_DE": ""
}
}
],
"default_editor_styles": {},
"connected_list_key_groups": [],
"quick_start_menus": []
}
DELETE /provisioning/organization/{organization_id}/xref-target-type-group¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/xref-target-type-group
METHOD: DELETE
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"key": "Courtstatement"
}
RESPONSE:
status: 204
POST /provisioning/organization/{organization_id}/default-settings¶
REQUEST:
URL: https://partner.smashdocs.net/api/provisioning/organization/d39f9433-00b3-424b-b797-3e23c0d44d56/default-settings
METHOD: POST
Headers:
content-type: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0Nzc2NDI1MzAsImlzcyI6IjU4MTMwOTlkNWNiOTE4OTllZWE2ZGEwNSIsImp0aSI6IjcyZTE1NjU2LWYzZDQtNGZhYS05MWNmLWQ1NWJjZjdjYzhmMCJ9.pDmg-kV-bzgDdDTZL5Kn4CgOgPGYpiTdnd9xfwNvROY
Payload:
{
"default_pd_key": "court_statement_text_1",
"word_import_conversation_type": {
"conversation_type_key": "comment",
"field_name": "main_comment"
},
"default_scope": "all",
"default_user_language": "en_EN",
"internal_user_domains": []
}
RESPONSE:
{
"default_pd_key": "court_statement_text_1",
"word_import_conversation_type": {
"conversation_type_key": "comment",
"field_name": "main_comment"
},
"default_user_language": "en_EN",
"default_scope": "all",
"internal_user_domains": [],
"projects_pd_restart_setting": false
}