PATCH /taskjournal/{uuid}

PATCH /taskjournal/{uuid}

/taskjournal/{uuid}

Request
URI
PATCH
https://{api_host}/api/taskjournal/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

TaskJournal object creation

TaskJournal of type(s) application/json
Optional

Show optional properties

{
    "summary": {
        "type": "string"
    }
}
{
    "_last_modified": "string",
    "errors": [
        {
            "details": [
                "string"
            ],
            "name": "string",
            "object": "string",
            "tenant": "string",
            "uuid": "string",
            "version": "string"
        }
    ],
    "image_ref": "string",
    "info": {
        "actions": [
            {
                "objects": [
                    {
                        "failed": 0,
                        "model": "string",
                        "skipped": 0,
                        "success": 0
                    }
                ],
                "version": "string"
            }
        ],
        "total_objects": 0,
        "versions": [
            "string"
        ]
    },
    "name": "string",
    "obj_cloud_ref": "string",
    "operation": "string",
    "patch_image_ref": "string",
    "summary": {
        "description": "string",
        "duration": 0,
        "end_time": "string",
        "error_count": 0,
        "reason": "string",
        "start_time": "string",
        "status": "string",
        "type": "string"
    },
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns TaskJournal of type(s) application/json 
"TaskJournal Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

array of object
errors
Optional

List of errors in the process. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
image_ref
Optional

Image uuid for identifying the current base image. It is a reference to an object of type Image. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
info
Optional

info

string
name
Optional

Name for the task journal. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
obj_cloud_ref
Optional

Cloud that this object belongs to. It is a reference to an object of type Cloud. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
operation
Optional

Operation for which the task journal created. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
patch_image_ref
Optional

Image uuid for identifying the current patch. It is a reference to an object of type Image. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
summary
Required

summary

string
tenant_ref
Optional

Tenant UUID associated with the Object. It is a reference to an object of type Tenant. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID Identifier for the task journal. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"summary:"object"}'
On This Page
Task Journal Operations
GET
GET /taskjournal
POST
POST /taskjournal
GET
GET /taskjournal/{uuid}
PUT
PUT /taskjournal/{uuid}
PATCH
PATCH /taskjournal/{uuid}
DELETE
DELETE /taskjournal/{uuid}