Templates Configuration

Create a new configuration document

Upload a new document to be used in templates

POST /orgs/{org_id}/templates/configurations/documents

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with one of Grupo MasOrange tenants
page	query	Page	false	Defines templates configuration page number to be show. If not defined, default value is 0 (first page).
pageSize	query	PageSize	false	Defines the number of items returned in each page. If not defined, default value is 50.
name	query	string	false	Filter by document name
extension	query	string	false	Filter by document extension
body	body	object	true	Define configuration fields with value by language

Request body - `Content-Type: multipart/form-data`

Custom schema example

1
2
3
4


name: masorange_logo
extension: pdf
content: string

Name	Type	Required	Description
name	string	true	Name of the document (without spaces).
extension	string	true	Format of the document to be stored. It must match the format of the binary
Allowed values: jpeg, jpg, png
content	string	true	Document content in binary format

Request example

1
2
3
4
5
6
7
8



curl -X POST https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/documents?page='0'&pageSize='1'&name='my_logo'&extension='png' \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -F "name=masorange_logo" \
  -F "extension=pdf" \
  -F "content=undefined" \

Responses

Code	Meaning	Description	Schema
200	OK	Configuration is created. Expected response for a valid request.	CreateConfigurationDocumentResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
422	Unprocessable Entity	Request input can not be processed (is incomplete)	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Get all tenant configuration documents

Get all configuration documents

GET /orgs/{org_id}/templates/configurations/documents

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with one of Grupo MasOrange tenants

Request example

1
2
3
4



curl -X GET https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/documents \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Tenant all templates configurations	GetAllConfigurationDocumentsResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
422	Unprocessable Entity	Request input can not be processed (is incomplete)	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Create or update a tenant templates configuration

POST /orgs/{org_id}/templates/configurations

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with one of Grupo MasOrange tenants
body	body	CreateOrUpdateTemplateConfigurationRequest	true	Define configuration fields with value by language

Request body - instance of CreateOrUpdateTemplateConfigurationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "changelog": "TEXT",
  "defaultLanguage": "ES",
  "fieldValues": [
    {
      "name": "CONFIG_TENANT.SOCIAL_REASON",
      "type": "TEXT",
      "value": [
        {
          "language": "ES",
          "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
changelog	ConfigurationChangelog	false	Description of the template change in this version
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
fieldValues	ConfigurationFieldValues	true	Configuration fields with default values by language

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21



curl -X POST https://documents.masstack.com/v1/orgs/masmovil/templates/configurations \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'changelog': 'TEXT',
  'defaultLanguage': 'ES',
  'fieldValues': [
    {
      'name': 'CONFIG_TENANT.SOCIAL_REASON',
      'type': 'TEXT',
      'value': [
        {
          'language': 'ES',
          'content': 'Avenida de Bruselas 38, Alcobendas, Madrid'
        }
      ]
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Configuration is created. Expected response for a valid request.	CreateOrUpdateTemplateConfigurationResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
422	Unprocessable Entity	Request input can not be processed (is incomplete)	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Get all tenant templates configurations

GET /orgs/{org_id}/templates/configurations

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with one of Grupo MasOrange tenants
page	query	Page	false	Defines templates configuration page number to be show. If not defined, default value is 0 (first page).
pageSize	query	PageSize	false	Defines the number of items returned in each page. If not defined, default value is 50.

Request example

1
2
3
4



curl -X GET https://documents.masstack.com/v1/orgs/masmovil/templates/configurations?page='0'&pageSize='1' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Tenant all templates configurations	GetAllTenantConfigurationsResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
422	Unprocessable Entity	Request input can not be processed (is incomplete)	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Get tenant templates configuration

GET /orgs/{org_id}/templates/configurations/{version}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with one of Grupo MasOrange tenants
version	path	string	true	Higher version of the template. You can use also ‘latest’ to get latest version

Request example

1
2
3
4



curl -X GET https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/1 \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Tenant templates configuration	GetTenantConfigurationResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
404	Not Found	resource not found	None
422	Unprocessable Entity	Request input can not be processed (is incomplete)	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Delete template configuration for a given version

Delete template configuration by version

DELETE /orgs/{org_id}/templates/configurations/{version}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with one of Grupo MasOrange tenants
version	path	string	true	Version of the template configuration.

Request example

1
2
3
4



curl -X DELETE https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/1 \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Action executed correctly	None
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
404	Not Found	resource not found	None
409	Conflict	conflict if form is in some section	None
422	Unprocessable Entity	Request input can not be processed (is incomplete)	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Templates Configuration

Create a new configuration document

Parameters

Request body - Content-Type: multipart/form-data

Request example

Responses

Get all tenant configuration documents

Parameters

Request example

Responses

Create or update a tenant templates configuration

Parameters

Request body - instance of CreateOrUpdateTemplateConfigurationRequest

Request example

Responses

Get all tenant templates configurations

Parameters

Request example

Responses

Get tenant templates configuration

Parameters

Request example

Responses

Delete template configuration for a given version

Parameters

Request example

Responses

Request body - `Content-Type: multipart/form-data`