Create A new endpoint type

Create A new endpoint type

The API creates a new endpoint type.

Request
URI
POST
https://{api_host}/iaas-proxy-provider/api/endpoint-configuration/endpointtypeoperations/create
COPY
Request Body

Request of endpoint type to be created.

endpointTypeRequest of type(s) application/json
Required 
{
    "endpointType": {
        "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",
        "menuItems": [
            {
                "displayName": "string",
                "icon": "string",
                "menuId": "string",
                "location": "string",
                "id": 0,
                "extensionId": "string"
            }
        ],
        "categoryDisplayName": "string",
        "description": "string",
        "version": 0,
        "tenantable": false,
        "lastUpdated": "string",
        "createdDate": "string",
        "tenantId": "string",
        "id": "string",
        "category": "string"
    }
}
endpointType
endpointType
Optional

endpointType

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",
    "menuItems": [
        {
            "displayName": "string",
            "icon": "string",
            "menuId": "string",
            "location": "string",
            "id": 0,
            "extensionId": "string"
        }
    ],
    "categoryDisplayName": "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

array of endpointMenuItem
menuItems
Optional

menuItems

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


403

Unauthorized.

Operation doesn't return any data structure

On This Page
Endpoint Configuration Operations
POST
Can delete An existing endpoint
POST
Can edit An existing endpoint
POST
Create A new endpoint
POST
Create A new endpoint type
POST
Delete An existing endpoint
POST
Delete An existing endpoint type
POST
Update An existing endpoint
POST
Update An existing endpoint type
POST
Validates An existing endpoint