Views

Create a new view

undefined

POST /views

Parameters

Name	In	Type	Required	Description
body	body	CatalogCreateViewRequest	true	‘none’

Request body - instance of CatalogCreateViewRequest

1
2
3
4
5


{
  "name": "kyc-consent-view",
  "orderDisplay": 1,
  "visibility": true
}

Name	Type	Required	Description
name	string	true	Name of the view
orderDisplay	integer	false	Display order for the view
visibility	boolean	false	Whether the view is visible

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://opengateway.masstack.com/v1/views \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'name': 'kyc-consent-view',
  'orderDisplay': 1,
  'visibility': true
}" 

Responses

Code	Meaning	Description	Schema
201	Created	View created successfully	CatalogViewResponse
400	Bad Request	Bad request - Invalid input	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Retrieve all views

undefined

GET /views

Parameters

Name	In	Type	Required	Description
visibility	query	boolean	false	Filter by visibility status
languageCode	query	string	false	Filter by language code (e.g., es-ES, eu-ES, en-US)

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/views?visibility='true'&languageCode='es-ES' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	List of views	CatalogViewListResponse
500	Internal Server Error	Internal server error	CatalogError

Retrieve a specific view by ID

undefined

GET /views/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/views/{id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	View found	CatalogViewResponse
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Update an existing view

undefined

PUT /views/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
body	body	CatalogUpdateViewRequest	true	‘none’

Request body - instance of CatalogUpdateViewRequest

1
2
3
4
5


{
  "name": "kyc-consent-view-updated",
  "orderDisplay": 2,
  "visibility": false
}

Name	Type	Required	Description
name	string	false	Updated name of the view
orderDisplay	integer	false	Updated display order
visibility	boolean	false	Updated visibility status

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X PUT https://opengateway.masstack.com/v1/views/{id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'name': 'kyc-consent-view-updated',
  'orderDisplay': 2,
  'visibility': false
}" 

Responses

Code	Meaning	Description	Schema
200	OK	View updated successfully	CatalogViewResponse
400	Bad Request	Bad request - Invalid input	CatalogError
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Delete a view (cascade delete translations and associations)

undefined

DELETE /views/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)

Request example

1
2
3
4



curl -X DELETE https://opengateway.masstack.com/v1/views/{id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	View deleted successfully	None
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Get all capabilities associated with a view

undefined

GET /views/{id}/capabilities

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/views/{id}/capabilities \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	List of capabilities associated with the view	CatalogCapabilityListResponse
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Associate a capability with a view

undefined

POST /views/{id}/capabilities

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
body	body	CatalogAddCapabilityToViewRequest	true	‘none’

Request body - instance of CatalogAddCapabilityToViewRequest

1
2
3


{
  "capabilityId": "550e8400-e29b-41d4-a716-446655440000"
}

Name	Type	Required	Description
capabilityId	string(uuid)	true	Capability ID to associate with the view

Request example

1
2
3
4
5
6
7
8



curl -X POST https://opengateway.masstack.com/v1/views/{id}/capabilities \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'capabilityId': '550e8400-e29b-41d4-a716-446655440000'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Capability successfully associated with view	CatalogAddCapabilityToViewResponse
400	Bad Request	Bad request - Invalid input	CatalogError
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Remove capability from view

undefined

DELETE /views/{id}/capabilities/{capability_id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
capability_id	path	string(uuid)	true	Capability ID (UUID)

Request example

1
2
3
4



curl -X DELETE https://opengateway.masstack.com/v1/views/{id}/capabilities/{capability_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Capability successfully removed from view	None
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Add a translation to a view

undefined

POST /views/{id}/translations

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
body	body	CatalogCreateTranslationRequest	true	‘none’

Request body - instance of CatalogCreateTranslationRequest

1
2
3
4


{
  "languageCode": "es-ES",
  "description": "Vista de consentimiento para KYC"
}

Name	Type	Required	Description
languageCode	string	true	Language code (e.g., es-ES, eu-ES, en-US)
description	string	false	Translated description

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://opengateway.masstack.com/v1/views/{id}/translations \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'languageCode': 'es-ES',
  'description': 'Vista de consentimiento para KYC'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Translation successfully added to view	CatalogTranslationResponse
400	Bad Request	Bad request - Invalid input	CatalogError
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Get all translations for a view

undefined

GET /views/{id}/translations

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/views/{id}/translations \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	List of translations for the view	CatalogTranslationListResponse
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Get a specific translation by language code

undefined

GET /views/{id}/translations/{language_code}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
language_code	path	string	true	Language code (e.g., es-ES, eu-ES, en-US)

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/views/{id}/translations/{language_code} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Translation found	CatalogTranslationResponse
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Update a translation for a view

undefined

PUT /views/{id}/translations/{language_code}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
language_code	path	string	true	Language code (e.g., es-ES, eu-ES, en-US)
body	body	CatalogUpdateTranslationRequest	true	‘none’

Request body - instance of CatalogUpdateTranslationRequest

1
2
3
4


{
  "languageCode": "es-ES",
  "description": "Vista de consentimiento para KYC actualizada"
}

Name	Type	Required	Description
languageCode	string	false	Updated language code
description	string	false	Updated translated description

Request example

1
2
3
4
5
6
7
8
9



curl -X PUT https://opengateway.masstack.com/v1/views/{id}/translations/{language_code} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'languageCode': 'es-ES',
  'description': 'Vista de consentimiento para KYC actualizada'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Translation updated successfully	CatalogTranslationResponse
400	Bad Request	Bad request - Invalid input	CatalogError
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError

Delete a translation from a view

undefined

DELETE /views/{id}/translations/{language_code}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	View ID (UUID)
language_code	path	string	true	Language code (e.g., es-ES, eu-ES, en-US)

Request example

1
2
3
4



curl -X DELETE https://opengateway.masstack.com/v1/views/{id}/translations/{language_code} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Translation deleted successfully	None
404	Not Found	Resource not found	CatalogError
500	Internal Server Error	Internal server error	CatalogError