CMS – Developers

Create Managed Folder

Creates a new managed folder in a specific bucket for a given organization.

POST /orgs/{org}/cms/managedFolders

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	ManagedFolderRequestDto	true	Managed Folder creation values

Request body - instance of ManagedFolderRequestDto

1
2
3
4


{
  "folderPath": "example_dir/",
  "user": "John_doe@example.com"
}

Name	Type	Required	Description
folderPath	string	true	Path of the managed folder
user	string	true	Email address of the user

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://communications.masstack.com/v2/orgs/yoigo/cms/managedFolders \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'folderPath': 'example_dir/',
  'user': 'John_doe@example.com'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Managed folder successfully created	ManagedFolderResponse
500	Internal Server Error	Server Error	ResponseErrorDto

Delete Managed Folder

Deletes a folder for CMS

DELETE /orgs/{org}/cms/managedFolders

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack
user	query	string	true	User
name	query	string	true	Folder Name

Request example

1
2
3
4
5



curl -X DELETE https://communications.masstack.com/v2/orgs/yoigo/cms/managedFolders?user='John_doe@example.com'&name='folderName'?user=John_doe%40example.com&name=folderName \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Folder deleted successfully	ManagedFolderResponse
400	Bad Request	User is not the owner hence not allowed to delete	ResponseErrorDto
500	Internal Server Error	Folder created within 24 hours	ResponseErrorDto

Get Object

Retrieves a CMS object based on the provided object name.

GET /orgs/{org}/cms/object

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack
objectName	query	string	true	Name of the CMS object to retrieve

Request example

1
2
3
4
5



curl -X GET https://communications.masstack.com/v2/orgs/yoigo/cms/object?objectName='tenant/logos/logo.png'?objectName=tenant%2Flogos%2Flogo.png \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully retrieved the CMS object	ObjectResponse
404	Not Found	Object not found	ResponseErrorDto
500	Internal Server Error	Server Error	ResponseErrorDto

Update Object

Updates an existing CMS object based on the provided object name and user information.

PUT /orgs/{org}/cms/object

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	UpdateObjectRequestDto	true	Update the CMS object values

Request body - instance of UpdateObjectRequestDto

1
2
3
4
5


{
  "sourceObjectName": "oldObject.png",
  "updatedObjectName": "newObject.png",
  "user": "John_doe@example.com"
}

Name	Type	Required	Description
sourceObjectName	string	true	Name of the source object to be updated
updatedObjectName	string	true	Name of the object after the update
user	string	true	Email address of the user

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X PUT https://communications.masstack.com/v2/orgs/yoigo/cms/object \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'sourceObjectName': 'oldObject.png',
  'updatedObjectName': 'newObject.png',
  'user': 'John_doe@example.com'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	CMS object successfully updated	ObjectResponse
500	Internal Server Error	Server Error	ResponseErrorDto

Create Object

Creates a new object inside a specific bucket (and inside a specific folder if required), based on Cloud Storage buckets inside the Google Cloud project. This service can only be called by MasCommunications administration service accounts

POST /orgs/{org}/cms/object

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	ResourceObjectRequestDto	true	CMS values

Request body - instance of ResourceObjectRequestDto

1
2
3
4
5


{
  "user": "John_doe@example.com",
  "objectName": "test-bucket.png",
  "fileContent": "UmVzZXQgeW91ciBwYXNzd29yZA=="
}

Name	Type	Required	Description
user	string	true	Email address of the user
objectName	string	true	Object name
fileContent	string	true	File path

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X POST https://communications.masstack.com/v2/orgs/yoigo/cms/object \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'user': 'John_doe@example.com',
  'objectName': 'test-bucket.png',
  'fileContent': 'UmVzZXQgeW91ciBwYXNzd29yZA=='
}" 

Responses

Code	Meaning	Description	Schema
201	Created	CMS object successfully created	ObjectResponse
500	Internal Server Error	Server Error	ResponseErrorDto

Delete Object

Delete Object for CMS

DELETE /orgs/{org}/cms/object

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack
objectName	query	string	true	Name of the CMS object to retrieve
user	query	string	true	User

Request example

1
2
3
4
5



curl -X DELETE https://communications.masstack.com/v2/orgs/yoigo/cms/object?objectName='tenant/logos/logo.png'&user='John_doe@example.com'?objectName=tenant%2Flogos%2Flogo.png&user=John_doe%40example.com \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Object deleted successfully	ObjectResponse
400	Bad Request	User is not the owner hence not allowed to delete	ResponseErrorDto
500	Internal Server Error	Object created within 24 hours	ResponseErrorDto

Get Content Tree

Retrieves the content tree for the CMS.

GET /orgs/{org}/cms/contentTree

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name as it is registered in Mas-Stack

Request example

1
2
3
4
5



curl -X GET https://communications.masstack.com/v2/orgs/yoigo/cms/contentTree \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully retrieved the CMS content tree	ContentTreeResponse
500	Internal Server Error	Internal server error	ResponseErrorDto