Create Composite Description

Create Composite Description

Only Solution users, Container admins, and System admins can create CompositeDescriptions.

Request
URI
POST
https://{api_host}/container-service/api/resources/composite-descriptions
COPY
Request Body
CompositeDescription of type(s) application/json
Optional 
{
    "documentExpirationTimeMicros": "string",
    "descriptionLinks": [
        "string"
    ],
    "documentSelfLink": "string",
    "bindings": [
        {
            "bindings": [
                {
                    "placeholder": {
                        "bindingExpression": "string",
                        "defaultValue": "string"
                    },
                    "originalFieldExpression": "string",
                    "targetFieldPath": [
                        "string"
                    ]
                }
            ],
            "componentName": "string"
        }
    ],
    "name": "string",
    "lastPublished": 0,
    "tenantLinks": [
        "string"
    ],
    "documentUpdateTimeMicros": "string",
    "status": "string",
    "parentDescriptionLink": "string"
}
string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

object
customProperties
Optional

customProperties

array of string
descriptionLinks
Optional

descriptionLinks

string
documentSelfLink
Optional

documentSelfLink

array of ComponentBinding
bindings
Optional

bindings

string
name
Optional

name

integer As int64 As int64
lastPublished
Optional

lastPublished

array of string
tenantLinks
Optional

tenantLinks

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

string
status
Optional

status

string
parentDescriptionLink
Optional

parentDescriptionLink

Responses
200

successful operation

Returns CompositeDescription of type(s) */* 
{
    "documentExpirationTimeMicros": "string",
    "descriptionLinks": [
        "string"
    ],
    "documentSelfLink": "string",
    "bindings": [
        {
            "bindings": [
                {
                    "placeholder": {
                        "bindingExpression": "string",
                        "defaultValue": "string"
                    },
                    "originalFieldExpression": "string",
                    "targetFieldPath": [
                        "string"
                    ]
                }
            ],
            "componentName": "string"
        }
    ],
    "name": "string",
    "lastPublished": 0,
    "tenantLinks": [
        "string"
    ],
    "documentUpdateTimeMicros": "string",
    "status": "string",
    "parentDescriptionLink": "string"
}
string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

object
customProperties
Optional

customProperties

array of string
descriptionLinks
Optional

descriptionLinks

string
documentSelfLink
Optional

documentSelfLink

array of ComponentBinding
bindings
Optional

bindings

string
name
Optional

name

integer As int64 As int64
lastPublished
Optional

lastPublished

array of string
tenantLinks
Optional

tenantLinks

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

string
status
Optional

status

string
parentDescriptionLink
Optional

parentDescriptionLink


201

'Created' is returned for the new state with the state url in the location header of the response;

Operation doesn't return any data structure

On This Page
Composite Operations
POST
Clone Composite Description
POST
Create Composite Component
POST
Create Composite Description
DELETE
Delete Composite Component
DELETE
Delete Composite Description
GET
Export Composite Description
GET
Get Composite Component
GET
Get Composite Description
POST
Import Composite Description
GET
List Composite Component
GET
List Composite Description
PATCH
Patch Composite Component
PATCH
Patch Composite Description
PUT
Update Composite Component
PUT
Update Composite Description