Message Brokers

List brokers

GEThttps://api.cegedim.cloud/itcare/message-brokers

Query parameters

servicesarray of integer (int64)

itemsinteger (int64)

namesarray of string

Names, example: resource01,!resource02,resource42

itemsstring

typesarray of string

Types, example: WINDOWS,AIX,LINUX

itemsstring

familiesarray of string

Families, example: DEBIAN,CENTOS,RHEL

itemsstring

environmentsarray of string

Environments, example: PRODUCTION,DEVELOPMENT

itemsstring

statusesarray of string

Status, example: ACTIVE,INACTIVE

itemsstring

tagsarray of string

Tags, example: mytagkey:mytagvalue,application:itcare

itemsstring

monitoringStatusboolean

Filter list by monitoring status

monitoringOnCallStatusboolean

Filter list by monitoring on call status

backupStatusboolean

Filter list by backup status

recoveryStatusboolean

Filter list by DRP status

includedInPatchPartyboolean

Filter list by patch party status

topologiesarray of string

Topology, example: Cluster, Standalone, etc..

itemsstring

versionsarray of string

Version, example: 2.7.0, 3.6.0, 3.9.29-1, etc...

itemsstring

cloudsinteger

pagestring

Results page you want to retrieve (0..N)

sizestring

Number of records per page.

sortany

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

Response

Body

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of BrokerV1 (object)

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

excluded*boolean

Tells if the resource is excluded or not from patch party

exclusionReasonstring

Raison why the resource should be excluded from patch party.

patchGroupstring

Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference

patchDatestring (date-time)

Date of the last System Upgrade.

patchTagstring

Tag to reference the last patch party

namestring

Name of the resource under patch party or not

idinteger (int64)

Id of the resource under patch party or not

excludedBystring

User who performed the exclusion from patch party action

exclusionDatestring (date-time)

Date on which the exclusion from patch party was performed

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

backupsarray of BackupInfoV1 (object)

idinteger (int64)

typestring

backupSizenumber (float)

backupLastDatestring (date-time)

policiesarray of ResourceBackupPolicyDetailsV1 (object)

namestring

labelstring

scopestring

typestring

replicationboolean

frequenciesJsonNode (object)

durationInHoursinteger (int32)

startTimestring

timezonestring

policyIdstring

backupLastDatestring (date-time)

backupSizenumber (float)

versionstring

sizingstring

nodeCountinteger (int64)

topologystring

cpuinteger (int64)

raminteger (int64)

numberinteger (int32)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageablePageableObject (object)

offsetinteger (int64)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageSizeinteger (int32)

pageNumberinteger (int32)

pagedboolean

unpagedboolean

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

Response

List brokers

GEThttps://api.cegedim.cloud/itcare/message-brokers

Query parameters

servicesarray of integer (int64)

itemsinteger (int64)

namesarray of string

Names, example: resource01,!resource02,resource42

itemsstring

typesarray of string

Types, example: WINDOWS,AIX,LINUX

itemsstring

familiesarray of string

Families, example: DEBIAN,CENTOS,RHEL

itemsstring

environmentsarray of string

Environments, example: PRODUCTION,DEVELOPMENT

itemsstring

statusesarray of string

Status, example: ACTIVE,INACTIVE

itemsstring

tagsarray of string

Tags, example: mytagkey:mytagvalue,application:itcare

itemsstring

monitoringStatusboolean

Filter list by monitoring status

monitoringOnCallStatusboolean

Filter list by monitoring on call status

backupStatusboolean

Filter list by backup status

recoveryStatusboolean

Filter list by DRP status

includedInPatchPartyboolean

Filter list by patch party status

topologiesarray of string

Topology, example: Cluster, Standalone, etc..

itemsstring

versionsarray of string

Version, example: 2.7.0, 3.6.0, 3.9.29-1, etc...

itemsstring

cloudsinteger

pagestring

Results page you want to retrieve (0..N)

sizestring

Number of records per page.

sortany

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

Response

Body

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of BrokerV1 (object)

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

excluded*boolean

Tells if the resource is excluded or not from patch party

exclusionReasonstring

Raison why the resource should be excluded from patch party.

patchGroupstring

Specification of the patch group, three sequences : '1', '2', '3'. '0' means no preference

patchDatestring (date-time)

Date of the last System Upgrade.

patchTagstring

Tag to reference the last patch party

namestring

Name of the resource under patch party or not

idinteger (int64)

Id of the resource under patch party or not

excludedBystring

User who performed the exclusion from patch party action

exclusionDatestring (date-time)

Date on which the exclusion from patch party was performed

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

backupsarray of BackupInfoV1 (object)

idinteger (int64)

typestring

backupSizenumber (float)

backupLastDatestring (date-time)

policiesarray of ResourceBackupPolicyDetailsV1 (object)

namestring

labelstring

scopestring

typestring

replicationboolean

frequenciesJsonNode (object)

durationInHoursinteger (int32)

startTimestring

timezonestring

policyIdstring

backupLastDatestring (date-time)

backupSizenumber (float)

versionstring

sizingstring

nodeCountinteger (int64)

topologystring

cpuinteger (int64)

raminteger (int64)

numberinteger (int32)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageablePageableObject (object)

offsetinteger (int64)

sortarray of SortObject (object)

directionstring

nullHandlingstring

ascendingboolean

propertystring

ignoreCaseboolean

pageSizeinteger (int32)

pageNumberinteger (int32)

pagedboolean

unpagedboolean

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": false,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "text",
      "type": "text",
      "internalType": "text",
      "status": "text",
      "category": "text",
      "technology": "text",
      "family": "text",
      "label": "text",
      "comment": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "cloudId": 0,
      "cloudName": "text",
      "serviceId": 0,
      "serviceName": "text",
      "serviceKey": "text",
      "environment": "text",
      "endOfSupportAt": "2025-01-05T07:42:52.315Z",
      "supportPhase": "text",
      "creationUser": "text",
      "creationTime": "text",
      "releasedAt": "2025-01-05T07:42:52.315Z",
      "endOfSalesAt": "2025-01-05T07:42:52.315Z",
      "extendedSupportAt": "2025-01-05T07:42:52.315Z",
      "monitoringEnabled": false,
      "monitoringAlerting": false,
      "monitoringOnCallEnabled": false,
      "monitoringRequested": false,
      "replicationStatus": false,
      "backupStatus": false,
      "patchParty": {
        "excluded": false,
        "exclusionReason": "text",
        "patchGroup": "text",
        "patchDate": "2025-01-05T07:42:52.315Z",
        "patchTag": "text",
        "name": "text",
        "id": 0,
        "excludedBy": "text",
        "exclusionDate": "2025-01-05T07:42:52.315Z"
      },
      "metrologyUrl": "text",
      "path": "text",
      "resourceType": "text",
      "internalResourceId": 0,
      "backupPolicyDetails": {
        "backups": [
          {
            "id": 0,
            "type": "text",
            "backupSize": 0,
            "backupLastDate": "2025-01-05T07:42:52.315Z"
          }
        ],
        "policies": [
          {
            "name": "text",
            "label": "text",
            "scope": "text",
            "type": "text",
            "replication": false,
            "durationInHours": 0,
            "startTime": "text",
            "timezone": "text",
            "policyId": "text",
            "backupLastDate": "2025-01-05T07:42:52.315Z",
            "backupSize": 0
          }
        ]
      },
      "version": "text",
      "sizing": "text",
      "nodeCount": 0,
      "topology": "text",
      "cpu": 0,
      "ram": 0
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": false,
      "property": "text",
      "ignoreCase": false
    }
  ],
  "pageable": {
    "offset": 0,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": false,
        "property": "text",
        "ignoreCase": false
      }
    ],
    "pageSize": 0,
    "pageNumber": 0,
    "paged": false,
    "unpaged": false
  },
  "numberOfElements": 0,
  "last": false,
  "empty": false
}