Create Endpoint
The API creates a new endpoint. The API performs the following validation before creating the endpoint:
1. The id of the endpoint is null.
2. Another endpoint wth the same name 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
POST
https://{api_host}/endpoint-configuration-service/api/endpoints
COPY
Request Body
Endpoint to be created.
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
200
Returns Endpoint of type(s) */*
{
"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
403
Unauthorized.
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