All URIs are relative to https://localhost/cloudapi
| Method | HTTP request | Description |
|---|---|---|
| CreateDefinedEntityType | Post /1.0.0/entityTypes/ | Creates a defined entity type. |
| DeleteDefinedEntityType | Delete /1.0.0/entityTypes/{id} | Deletes the entity type with the unique identifier (URN) |
| GetDefinedEntityType | Get /1.0.0/entityTypes/{id} | Gets the entity type with the unique identifier (URN) |
| GetDefinedEntityTypes | Get /1.0.0/entityTypes/ | Gets the collection of entity types defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering |
| UpdateDefinedEntityType | Put /1.0.0/entityTypes/{id} | Updates the entity type with the unique identifier (URN) |
DefinedEntityType CreateDefinedEntityType(ctx, definition) Creates a defined entity type.
Creates a defined entity type.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| definition | DefinedEntityType |
- Content-Type: application/json
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDefinedEntityType(ctx, id) Deletes the entity type with the unique identifier (URN)
Deletes the entity type with the unique identifier (URN)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
(empty response body)
- Content-Type: Not defined
- Accept: /;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DefinedEntityType GetDefinedEntityType(ctx, id) Gets the entity type with the unique identifier (URN)
Gets the entity type with the unique identifier (URN)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DefinedEntityTypes GetDefinedEntityTypes(ctx, page, pageSize, optional) Gets the collection of entity types defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering
Gets the collection of entity types defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| page | int32 | Page to fetch, zero offset. | [default to 1] |
| pageSize | int32 | Results per page to fetch. | [default to 25] |
| optional | *DefinedEntityTypeApiGetDefinedEntityTypesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefinedEntityTypeApiGetDefinedEntityTypesOpts struct
| Name | Type | Description | Notes |
|---|
filter | optional.String| Filter for a query. FIQL format. | sortAsc | optional.String| Field to use for ascending sort | sortDesc | optional.String| Field to use for descending sort |
- Content-Type: Not defined
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DefinedEntityType UpdateDefinedEntityType(ctx, definition, id) Updates the entity type with the unique identifier (URN)
Updates the entity type with the unique identifier (URN)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| definition | DefinedEntityType | ||
| id | string |
- Content-Type: application/json
- Accept: application/json;version=36.0
[Back to top] [Back to API list] [Back to Model list] [Back to README]