Jump to

• Request
• Response
• Examples

Get gateway artifacts of a specified name, version and type

get

/apiplatform/administration/v1/artifacts/{name}/types/{type}/versions/{version}

Returns the gateway artifact with the specified {name}, {type}, and {version}. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the Administrator role.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name of an artifact.
• type: string
  The file type of an artifact (like zip or jar).
• version: string
  The version of an artifact.

Query Parameters

• fields(optional): array
  Collection Format: csv

  Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The gateway artifact with the specified name, type and version.

Body ()

Root Schema : Artifact

Type: object

Show Source

• createdAt(optional): string
  The date and time the artifact was created.
• createdBy(optional): string
  The user who created the artifact.
• description(optional): string
  The artifact's description.
• lastUpdatedAt(optional): string
  The date and time the artifact was last updated.
• lastUpdatedBy(optional): string
  The user who last updated the artifact.
• name(optional): string
  The artifact's name.
• revision(optional): integer
  The artifact's revision.
• type(optional): string
  The artifact's file type (like zip or jar).
• version(optional): string
  The artifact's version.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The artifact's name."
        },
        "type":{
            "type":"string",
            "description":"The artifact's file type (like zip or jar)."
        },
        "version":{
            "type":"string",
            "description":"The artifact's version."
        },
        "revision":{
            "type":"integer",
            "description":"The artifact's revision."
        },
        "description":{
            "type":"string",
            "description":"The artifact's description."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the artifact was created."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the artifact."
        },
        "lastUpdatedAt":{
            "type":"string",
            "description":"The date and time the artifact was last updated."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the artifact."
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

404 Response

Not Found.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve details about artifacts of a specific name, type, and version by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/administration/v1/artifacts/apics-analytics.logstash.config/types/zip/versions/1.0

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.2.0
Date: Thu, 05 Jan 2017 18:27:21 GMT
Content-length: 462
Content-type: application/json
X-oracle-dms-ecid: mbwZ3133000000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including <additoinal information>:

{
  "createdAt": "2017-01-05T02:46:36+0000",
  "updatedBy": "anonymous",
  "createdBy": "anonymous",
  "name": "apics-analytics.logstash.config",
  "description": "Properties for Analytics Agent & Logstash",
  "links": [
    {
      "templated": "true",
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/administration/v1/artifacts/apics-analytics.logstash.config/types/zip/versions/1.0"
    }
  ],
  "type": "zip",
  "version": "1.0",
  "revision": 1,
  "updatedAt": "2017-01-05T02:46:36+0000"
}

Back to Top