Get gateway artifacts of a specified name
get
/apiplatform/administration/v1/artifacts/{name}
Returns gateway artifacts of the specified {name}
. 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.
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. - links(optional): array
Response
Supported Media Types
- application/json
200 Response
A collection of gateway artifacts with the specified name.
Nested Schema : ArtifactCollectionResponse-allOf[0]
Type:
Show Source
object
-
items(optional):
array items
A collection of artifacts.
Nested Schema : CollectionResponseFeature
Type:
Show Source
object
-
count(optional):
integer(int32)
The number of items in this collection.
Nested Schema : LinksResponseFeature
Type:
Show Source
object
-
links(optional):
array links
Includes 'canonical'.
Nested Schema : Artifact
Type:
Show Source
object
-
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.
Nested Schema : HATEOASLink
Type:
Show Source
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
object
-
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
500 Response
Unexpected error.
Root Schema : Error
Type:
Show Source
object
-
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
Examples
The following example shows how to retrieve details about artifacts of a specified name 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/oracle.apiplatform.analytics.agent
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:19:58 GMT Content-length: 604 Content-type: application/json X-oracle-dms-ecid: Hc4yQ0a3000000000 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 details about the artifact and HATEOAS links to related operations.
{ "count": 1, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/administration/v1/artifacts/oracle.apiplatform.analytics.agent" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/administration/v1/artifacts/oracle.apiplatform.analytics.agent" } ], "items": [ { "createdAt": "2017-01-05T02:46:36+0000", "updatedBy": "anonymous", "createdBy": "anonymous", "name": "oracle.apiplatform.analytics.agent", "description": "Analytics Agent ear", "type": "ear", "version": "1.0", "revision": 1, "updatedAt": "2017-01-05T02:46:36+0000" } ] }