Jump to

• Request
• Response
• Examples

Get Information about artifacts deployed on this node

get

/apiplatform/gatewaynode/v1/config/artifacts

Returns metadata information about all artifacts deployed on this node.

Users requesting this resource must be assigned the Gateway Manager role for the logical gateway this node is registered to.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

The artifacts deployed on this node.

Body ()

Returns metadata information for all deployed artifacts.

Root Schema : ArtifactsDetails

Returns metadata information for all deployed artifacts.

Match All

Show Source

• object ArtifactsMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/ArtifactsMetadata"
        }
    ],
    "description":"Returns metadata information for all deployed artifacts."
}

Nested Schema : ArtifactsMetadata

Type: object

Show Source

• count: string
  Count of artifacts.
• items: array items

{
    "type":"object",
    "required":[
        "count",
        "items"
    ],
    "properties":{
        "count":{
            "type":"string",
            "description":"Count of artifacts."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactMetadata"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ArtifactMetadata

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ArtifactMetadata"
    }
}

Nested Schema : ArtifactMetadata

Type: object

Show Source

• mutable: boolean
  True if artifact is mutable, false otherwise
• name: string
  Name of the artifact.
• revision: string
  Revision of the artifact.
• type: string
  Type of the artifact.
• version: string
  Version of the artifact.

{
    "type":"object",
    "required":[
        "mutable",
        "name",
        "revision",
        "type",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the artifact."
        },
        "type":{
            "type":"string",
            "description":"Type of the artifact."
        },
        "version":{
            "type":"string",
            "description":"Version of the artifact."
        },
        "revision":{
            "type":"string",
            "description":"Revision of the artifact."
        },
        "mutable":{
            "type":"boolean",
            "description":"True if artifact is mutable, false otherwise"
        }
    }
}

401 Response

Authentication required.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

403 Response

Forbidden.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

500 Response

Unexpected error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

503 Response

Temporarily unavailable error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

Back to Top

Examples

The following example shows how to retrieve the status of a gateway node 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/gatewaynode/v1/config/artifacts

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 13 Sep 2017 15:28:36 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format, including details about the artifacts deployed to the node.

{
    "count": 2,
    "items": [
        {
            "name": "SharedSDK",
            "mutable": false,
            "type": "runtime.sdk.ear",
            "version": "5.0",
            "revision": "1"
        },
        {
            "name": "GatewayController",
            "mutable": false,
            "type": "runtime.gc.ear",
            "version": "1.0",
            "revision": "4"
        }
    ]
}

Back to Top