Get Resource

Get Resource

The returned definition contains base data for the resource. When this endpoint is called with the MIME type of the specified resource as the desired response content type, this operation is the equivalent of "Export resource": Exports a resource by its ID. If the request is successful, the resource binary content is available in the body of response message. It is up to the client application to properly fetch and process this attachment, for example by saving it to local file system. The exported resource has the same internal format as the resource exported using VCF Operations Orchestrator client.

Request
URI
GET
https://{api_host}/vco/api/resources/{id}
COPY
Path Parameters
string
id
Required

id


Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns Resource of type(s) application/vnd.o11n.resource.metadata+json
{
    "relations": {
        "startIndex": 0,
        "count": 0,
        "total": 0,
        "link": [
            {
                "rel": "string",
                "type": "string",
                "attributes": [
                    {
                        "name": "string",
                        "displayName": "string",
                        "value": "string",
                        "displayValue": "string"
                    }
                ],
                "href": "string"
            }
        ]
    },
    "id": "string",
    "name": "string",
    "description": "string",
    "version": "string",
    "status": 0,
    "href": "string",
    "category-id": "string",
    "mime-type": "string"
}
object
relations
Optional

relations

string
id
Optional

id

string
name
Optional

name

string
description
Optional

description

string
version
Optional

version

integer As int32 As int32
status
Optional

status

string
href
Optional

href

string
category-id
Optional

category-id

string
mime-type
Optional

mime-type


401

User is not authorized

Returns Resource of type(s) application/vnd.o11n.resource.metadata+json
"Resource Object"
object
relations
Optional

relations

string
id
Optional

id

string
name
Optional

name

string
description
Optional

description

string
version
Optional

version

integer As int32 As int32
status
Optional

status

string
href
Optional

href

string
category-id
Optional

category-id

string
mime-type
Optional

mime-type


404

Cannot find resource with the specified ID.

Returns Resource of type(s) application/vnd.o11n.resource.metadata+json
"Resource Object"
object
relations
Optional

relations

string
id
Optional

id

string
name
Optional

name

string
description
Optional

description

string
version
Optional

version

integer As int32 As int32
status
Optional

status

string
href
Optional

href

string
category-id
Optional

category-id

string
mime-type
Optional

mime-type


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/resources/{id}