Update Endpoint
The API updates an existing endpoint. The API performs the following validation before updating the endpoint:
1. There is an existing endpoint with the specified id.
2. Another endpoint wth the same name does exist.
3. The type of the endpoint is already registered.
4. The endpoint passes schema validation, based on the endpoint type's schema.
Request
URI
PUT
https://{api_host}/endpoint-configuration-service/api/endpoints/{id}
COPY
Path Parameters
string
id
Required
Id of the endpoint to be updated.
Request Body
Endpoint to be updated.
Endpoint of type(s) application/json
Required
{
"associations": [
{
"lastUpdated": "string",
"createdDate": "string",
"customProperties": "string",
"fromEndpointType": "string",
"associationTypeInfoId": "string",
"id": "string",
"toEndpointId": "string",
"toEndpointType": "string",
"version": 0,
"fromEndpointId": "string"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"typeId": "string",
"id": "string",
"typeDisplayName": "string",
"version": 0,
"uri": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
typeId
Optional
typeId
string As uuid As uuid
id
Optional
id
string
typeDisplayName
Optional
typeDisplayName
integer As int64 As int64
version
Optional
version
string
uri
Optional
uri
Responses
204
Operation doesn't return any data structure
403
Unauthorized.
Operation doesn't return any data structure
404
Endpoint 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
503
Dependent service is unavailable.
Operation doesn't return any data structure