Get Using GET 4

Get Using GET 4

Get a User Operation with the given id

Request
URI
GET
http://cava-s-182-041.eng.vmware.com//codestream/api/user-operations/{id}
COPY
Path Parameters
string
id
Required

The ID of the User Operation

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about


Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the requested User Operation

Returns UserOperation of type(s) */*
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_expiresOnInMicros": 1569216876209000,
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_requestedOnInMicros": 1568957676209000,
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "approvers": [
        "string"
    ],
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "endpoint": "My-email-endpoint",
    "executionId": "19e2d2c3-41b6-4bc0-9f27-b3f935d25366",
    "executionIndex": 8,
    "executionLink": "/codestream/api/executions/c1c08fc4-0bef-46fa-b5d2-c8aa10d18f6e",
    "expirationInDays": 3,
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "index": "45b4d8",
    "name": "My-Name",
    "pipelineId": "6f6b006b-7fec-4684-9200-21a4a782c82b",
    "pipelineName": "My-Pipeline",
    "project": "My-Project",
    "requestedBy": "fritz",
    "respondedBy": "fritz",
    "responseMessage": "Approved on Monday",
    "sendemail": true,
    "status": "Approved",
    "summary": "To be approved only by admin",
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}
integer As int64 As int64
_createTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string
_createdBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

integer As int64 As int64
_expiresOnInMicros
Optional

The time in micros when it would expire.

string
_link
Optional

Partial URL that provides details of the resource.

integer As int64 As int64
_requestedOnInMicros
Optional

The time in micros when the request was made.

integer As int64 As int64
_updateTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string
_updatedBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

array of string
approvers
Optional

The list of approver emails who can approve it.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string
createdBy
Optional

The user that created this entity

string
description
Required

A human-friendly description.

string
endpoint
Optional

The email Endpoint to be used if the sendemail is set to true.

string
executionId
Optional

The Execution id of the Pipeline Execution consisting of this task.

integer As int64 As int64
executionIndex
Optional

The index of the Pipeline Execution in which the entity is present.

string
executionLink
Optional

The Execution link of the Pipeline Execution consisting of this task.

integer As int32 As int32
expirationInDays
Optional

The time in days after which this entity would expire.

string
id
Optional

The id of this resource.

string
index
Optional

The index of the entity.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
pipelineId
Optional

The id of the Pipeline consisting of this task.

string
pipelineName
Optional

The name of the Pipeline this task is configured in.

string
project
Optional

The project this entity belongs to.

string
requestedBy
Optional

The user who requested this.

string
respondedBy
Optional

The user who responded to this approval.

string
responseMessage
Optional

The response message which the responder would like to give.

boolean
sendemail
Optional

The flag to determine if an email has to be sent.

string
status
Optional

The status of this entity.

string
summary
Optional

The summary of this entity.

string
updatedAt
Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string
updatedBy
Optional

The user that last updated this entity

string
version
Optional

Version of the resource.


401

Unauthorized Request

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Server Error

Operation doesn't return any data structure