content library item update session: create
Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
Content Library Service allows only one single update session to be active for a specific library item.
Request:
HTTP request
POST https://{server}/rest/com/vmware/content/library/item/update-session
Request Body Structure:
{
"client_token" : "string",
"create_spec" : {
"library_item_id" : "obj-103",
"error_message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"warning_behavior" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE"
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE"
}
],
"client_progress" : 1,
"expiration_time" : "2015-01-01T22:13:05.651Z",
"preview_info" : {
"warnings" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"state" : "UNAVAILABLE",
"certificate_info" : {
"x509" : "string",
"subject" : "string",
"self_signed" : true,
"issuer" : "string"
}
},
"id" : "obj-103",
"library_item_content_version" : "string",
"state" : "ACTIVE"
}
}
"client_token" : "string",
"create_spec" : {
"library_item_id" : "obj-103",
"error_message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"warning_behavior" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE"
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE"
}
],
"client_progress" : 1,
"expiration_time" : "2015-01-01T22:13:05.651Z",
"preview_info" : {
"warnings" : [
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"ignored" : true,
"type" : "SELF_SIGNED_CERTIFICATE",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"state" : "UNAVAILABLE",
"certificate_info" : {
"x509" : "string",
"subject" : "string",
"self_signed" : true,
"issuer" : "string"
}
},
"id" : "obj-103",
"library_item_content_version" : "string",
"state" : "ACTIVE"
}
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| client_token | string | Optional. Unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. |
| create_spec | update_session_model | Specification for the new update session to be created. |
| create_spec.id | string | The identifier of this update session. Optional. This field is not used for the create operation. It will not be present in the result of the get or list operations. It is not used for the update operation.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. |
| create_spec.library_item_id | string | The identifier of the library item to which content will be uploaded or removed. Optional. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item. |
| create_spec.library_item_content_version | string | The content version of the library item whose content is being modified. This value is the content.library.item_model.content_version at the time when the session is created for the library item. Optional. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. |
| create_spec.error_message | localizable_message | If the session is in the ERROR status this property will have more details about the error. Optional. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation. |
| create_spec.error_message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| create_spec.error_message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| create_spec.error_message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| create_spec.error_message.params | list | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| create_spec.error_message.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| create_spec.client_progress | long | The progress that has been made with the upload. This property is to be updated by the client during the upload process to indicate the progress of its work in completing the upload. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the update is complete. Optional. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. |
| create_spec.state | string | The current state (ACTIVE, DONE, ERROR, CANCELED) of the update session. This attribute was added in vSphere API 6.8. The state of an update session. Value is one of:ACTIVE: The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage. DONE: The session is done and all its effects are now visible. ERROR: There was an error during the session. CANCELED: The session has been canceled.Optional. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. |
| create_spec.expiration_time | date_time | Indicates the time after which the session will expire. The session is guaranteed not to expire earlier than this time. Optional. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. |
| create_spec.preview_info | preview_info | A preview of the files currently being uploaded in the session. This property will be set only when the session is in the ACTIVE. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value ACTIVE. This field is optional and it is only relevant when the value of state is ACTIVE. |
| create_spec.preview_info.state | string | Indicates the state of the preview of the update session. This attribute was added in vSphere API 6.8. Defines the state of the update session's preview. This enumeration was added in vSphere API 6.8. Value is one of: UNAVAILABLE: There are no files in the update session OR a preview is not possible for the files currently in the update session. However, preview may be possible after metadata files such as OVF descriptor are added to the session. In this case the state will transition to PREPARING. This constant was added in vSphere API 6.8.NOT_APPLICABLE: Preview is not possible for this update session. This state is reached when there are no metadata files in the update session and user invokes a session complete operation. This constant was added in vSphere API 6.8. PREPARING: A preview is being prepared for the files currently in the update session. This state is reached when the applicable metadata files are added to the update session but their content is not fully uploaded yet. For OVF item type, this state indicates that the OVF descriptor file is currently being uploaded. This constant was added in vSphere API 6.8. AVAILABLE: Preview is available for this update session. It is possible to review certificate details and warnings, if any. This state is reached when the applicable metadata files in the session have been fully uploaded. This constant was added in vSphere API 6.8. |
| create_spec.preview_info.certificate_info | certificate_info | The certificate information of the signed update session content. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value AVAILABLE. This field is unset if the update session content is not signed. |
| create_spec.preview_info.certificate_info.issuer | string | Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This attribute was added in vSphere API 6.8. |
| create_spec.preview_info.certificate_info.subject | string | Certificate subject. For example: C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This attribute was added in vSphere API 6.8. |
| create_spec.preview_info.certificate_info.self_signed | boolean | Whether the certificate is self-signed. This attribute was added in vSphere API 6.8. |
| create_spec.preview_info.certificate_info.x509 | string | The X509 representation of the certificate. This attribute was added in vSphere API 6.8. |
| create_spec.preview_info.warnings | preview_warning_info[] | The list of warnings raised for this update session. Any warning which is not ignored by the client will, by default, fail the update session during session complete operation. This attribute was added in vSphere API 6.8. Optional. It is only relevant when state has value AVAILABLE. This field is optional and it is only relevant when the value of state is AVAILABLE. |
| create_spec.warning_behavior | warning_behavior[] | Indicates the update session behavior if warnings are raised in the session preview. Any warning which is raised by session preview but not ignored by the client will, by default, fail the update session. This attribute was added in vSphere API 6.8. Optional. This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : "obj-103"
}
"value" : "obj-103"
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | string | Identifier of the new update session being created. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 400 | invalid_argument | if the session specification is not valid. |
| 400 | invalid_element_type | if the update session is being created on a subscribed library item. |
| 404 | not_found | if the item targeted for update does not exist. |
| 500 | resource_busy | if there is another update session on the same library item. |