Update Endpoint Type
The API updates an existing endpoint type. The API performs the following validation before updating the endpoint type:
1. There is an existing endpoint type with the specified id.
2. Another endpoint type wth the same name does not exist.
Request
URI
PUT
https://{api_host}/endpoint-configuration-service/api/types/{id}
COPY
Path Parameters
string
id
Required
Id of the endpoint type to be updated.
Request Body
Endpoint type to be updated with.
EndpointType of type(s) application/json
Required
{
"schema": {
"fields": [
{
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"orderIndex": 0,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
},
"serviceProviderId": "string",
"capabilities": "string",
"displayName": "string",
"categoryDisplayName": "string",
"menuItems": [
{
"displayName": "string",
"icon": "string",
"menuId": "string",
"location": "string",
"id": 0,
"extensionId": "string"
}
],
"description": "string",
"version": 0,
"tenantable": false,
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"id": "string",
"category": "string"
}string
serviceProviderId
Optional
serviceProviderId
string
capabilities
Optional
capabilities
string
displayName
Optional
displayName
string
categoryDisplayName
Optional
categoryDisplayName
string
description
Optional
description
integer As int64 As int64
version
Optional
version
boolean
tenantable
Optional
tenantable
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
string
id
Optional
id
string
category
Optional
category
Responses
204
Operation doesn't return any data structure
403
Unauthorized.
Operation doesn't return any data structure
404
Endpoint type with the specified id does not exist.
Operation doesn't return any data structure
405
Request failed validation.
Operation doesn't return any data structure
501
Tenantable endpoint types cannot be created.
Operation doesn't return any data structure