Capabilities

Create a new capability

undefined

POST /capabilities

Parameters

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

Request body - instance of CatalogCreateCapabilityRequest

1
2
3


{
  "name": "kyc-match"
}

Name	Type	Required	Description
name	string	true	Name of the capability (CAMARA capability name)

Request example

1
2
3
4
5
6
7
8



curl -X POST https://opengateway.masstack.com/v1/capabilities \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'name': 'kyc-match'
}" 

Responses

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

Retrieve all capabilities

undefined

GET /capabilities

Parameters

Name	In	Type	Required	Description
name	query	string	false	Filter capabilities by name

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/capabilities?name='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	List of capabilities	CatalogCapabilityListResponse
500	Internal Server Error	Internal server error	CatalogError

Retrieve a specific capability by ID

undefined

GET /capabilities/{id}

Parameters

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

Request example

1
2
3
4



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

Responses

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

Update an existing capability

undefined

PUT /capabilities/{id}

Parameters

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

Request body - instance of CatalogUpdateCapabilityRequest

1
2
3


{
  "name": "sim-swap"
}

Name	Type	Required	Description
name	string	false	Updated name of the capability

Request example

1
2
3
4
5
6
7
8



curl -X PUT https://opengateway.masstack.com/v1/capabilities/{id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'name': 'sim-swap'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Capability updated successfully	CatalogCapabilityResponse
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 capability

undefined

DELETE /capabilities/{id}

Parameters

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

Request example

1
2
3
4



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

Responses

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

Get all views associated with a capability

undefined

GET /capabilities/{id}/views

Parameters

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

Request example

1
2
3
4



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

Responses

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

Associate a view with a capability

undefined

POST /capabilities/{id}/views

Parameters

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

Request body - instance of CatalogAddViewToCapabilityRequest

1
2
3


{
  "viewId": "550e8400-e29b-41d4-a716-446655440002"
}

Name	Type	Required	Description
viewId	string(uuid)	true	View ID to associate with the capability

Request example

1
2
3
4
5
6
7
8



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

Responses

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

Remove view from capability

undefined

DELETE /capabilities/{id}/views/{view_id}

Parameters

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

Request example

1
2
3
4



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

Responses

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