Get Endpoint Type By Id

Get Endpoint Type By Id

The API returns a specific endpoint type, based on the endpoint type id.

Request
URI
GET
https://{api_host}/endpoint-configuration-service/api/types/{id}
COPY
Path Parameters
string
id
Required

The id of the endpoint type to be retrieved.

Responses
200
Returns EndpointType of type(s) */* 
{
    "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"
}
Schema
schema
Optional

schema

string
serviceProviderId
Optional

serviceProviderId

string
capabilities
Optional

capabilities

string
displayName
Optional

displayName

string
categoryDisplayName
Optional

categoryDisplayName

array of EndpointMenuItem
menuItems
Optional

menuItems

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


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

On This Page
Endpoint Types Operations
POST
Create Endpoint Type
DELETE
Delete Endpoint Type
GET
Get Association Types By Endpoint Id
GET
Get Endpoint Type By Id
GET
Get Endpoint Types
PUT
Update Endpoint Type