Get information about all components on the server

This command returns a JSON representation of all components on the server.

Request

GET https://{hostname}:{port}
    /cli/component?{parameters}
Accept: {contentType}
Table 1. Request parameters
Parameter Type Required Description
active boolean false
Table 2. Header parameters
Parameter Type Required Description
Accept
  • application/json
  • application/yaml
 true

Example

curl -k -u jsmith:passwd 
   
  "https://deployserver.example.com:8443/cli/component
  ?active=true&inactive=false"

Example response

[
  {
    "id": "69a6a5bd-583b-4b40-bd47-54b28f5aa1e6",
    "name": "JPetStore-APP",
    "description": "",
    "created": 1387315824908,
    "importAutomatically": false,
    "useVfs": true,
    "active": true,
    "deleted": false,
    "defaultVersionType": "FULL",
    "cleanupDaysToKeep": 0,
    "cleanupCountToKeep": 0,
    "tags": [
      {
        "id": "d140ae5a-dfb0-477a-910b-762cc0d99cc6",
        "name": "Tag2",
        "color": "#7fff00",
        "description": "",
        "objectType": "Component"
      }
    ],
    "user": "admin"
  },
  {
    "id": "f4a37f52-7d96-4fb5-b43b-57166b177e7c",
    "name": "JPetStore-DB",
    "description": "",
    "created": 1387316389625,
    "importAutomatically": false,
    "useVfs": true,
    "active": true,
    "deleted": false,
    "defaultVersionType": "FULL",
    "cleanupDaysToKeep": 0,
    "cleanupCountToKeep": 0,
    "tags": [
    ],
    "user": "admin"
  },
  {
    "id": "76299d8e-c328-42f4-99ab-aa7bfee7aa14",
    "name": "JPetStore-WEB",
    "description": "",
    "created": 1387316469977,
    "importAutomatically": false,
    "useVfs": true,
    "active": true,
    "deleted": false,
    "defaultVersionType": "FULL",
    "cleanupDaysToKeep": 0,
    "cleanupCountToKeep": 0,
    "tags": [
    ],
    "user": "admin"
  }
]

Related CLI command: getComponents.