Jump to

• Request
• Response

Retrieve Integration Usages

get

/ic/api/integration/v1/usage

Retrieves information about integration resources and usages. This function provides usage metrics of domain value maps, application instances, integrations, integration designs, packages, messages, agent, adpaters, API libraries, message system, and schedules.

Request

Query Parameters

• excludeFields: string
• fields: string
• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : UsageMetricsRs

Type: object

Show Source

• adapter-metrics: object UsageMetricsRs.AdapterUsageMetricsRs
• agent-metrics: object UsageMetricsRs.AgentUsageMetricsRs
• api-library-usage-metrics: object UsageMetricsRs.APILibraryUsageMetricsRs
• application-instance-usage-metrics: UsageMetricsRs.AppInstanceUsageMetricsRs
• domain-value-map-usage-metrics: UsageMetricsRs.DVMUsageMetricsRs
• integration-design-metrics: object UsageMetricsRs.IntegrationDesignMetricsRs
• integration-state-metrics: object UsageMetricsRs.IntegrationStateMetricsRs
• integration-usage-metrics: UsageMetricsRs.IntegrationUsageMetricsRs
• message-metrics: object UsageMetricsRs.MessageMetricsRs
• message-system-metrics: object UsageMetricsRs.MessageSystemUsageRs
• package-usage-metrics: object UsageMetricsRs.PackageUsageMetricsRs
• project-state-metrics: object UsageMetricsRs.ProjectStateMetricsRs
• project-type-metrics: object UsageMetricsRs.ProjectTypeMetricsRs
• schedule-usage-metrics: object UsageMetricsRs.ScheduleUsageMetricsRs

{
    "type":"object",
    "properties":{
        "project-state-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.ProjectStateMetricsRs"
        },
        "project-type-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.ProjectTypeMetricsRs"
        },
        "domain-value-map-usage-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.DVMUsageMetricsRs"
        },
        "application-instance-usage-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.AppInstanceUsageMetricsRs"
        },
        "integration-usage-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.IntegrationUsageMetricsRs"
        },
        "integration-design-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.IntegrationDesignMetricsRs"
        },
        "package-usage-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.PackageUsageMetricsRs"
        },
        "message-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.MessageMetricsRs"
        },
        "agent-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.AgentUsageMetricsRs"
        },
        "adapter-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.AdapterUsageMetricsRs"
        },
        "api-library-usage-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.APILibraryUsageMetricsRs"
        },
        "message-system-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.MessageSystemUsageRs"
        },
        "schedule-usage-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.ScheduleUsageMetricsRs"
        },
        "integration-state-metrics":{
            "$ref":"#/components/schemas/UsageMetricsRs.IntegrationStateMetricsRs"
        }
    }
}

Nested Schema : UsageMetricsRs.AdapterUsageMetricsRs

Type: object

Show Source

• adapter-count: object UsageMetricsRs.AdapterCountRs

{
    "type":"object",
    "properties":{
        "adapter-count":{
            "$ref":"#/components/schemas/UsageMetricsRs.AdapterCountRs"
        }
    }
}

Nested Schema : UsageMetricsRs.AgentUsageMetricsRs

Type: object

Show Source

• agents-by-group: object agents-by-group
  Additional Properties Allowed: additionalProperties
• count-agent-groups: integer (int32)
• count-conn-agents: integer (int32)
• count-exec-agents: integer (int32)
• number-of-down-agents: integer (int32)
• total-agents: integer (int32)

{
    "type":"object",
    "properties":{
        "total-agents":{
            "type":"integer",
            "format":"int32"
        },
        "number-of-down-agents":{
            "type":"integer",
            "format":"int32"
        },
        "count-agent-groups":{
            "type":"integer",
            "format":"int32"
        },
        "count-conn-agents":{
            "type":"integer",
            "format":"int32"
        },
        "count-exec-agents":{
            "type":"integer",
            "format":"int32"
        },
        "agents-by-group":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        }
    }
}

Nested Schema : UsageMetricsRs.APILibraryUsageMetricsRs

Type: object

Show Source

• configured: integer (int64)
• in-progress: integer (int64)
• total: integer (int64)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int64"
        },
        "in-progress":{
            "type":"integer",
            "format":"int64"
        },
        "configured":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.AppInstanceUsageMetricsRs

Match All

Show Source

• object UsageMetricsRs.AppInstanceUsageMetricsBaseRs
• object UsageMetricsRs.AppInstanceUsageMetricsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageMetricsRs.AppInstanceUsageMetricsBaseRs"
        },
        {
            "type":"object",
            "properties":{
                "used":{
                    "type":"integer",
                    "format":"int64"
                },
                "typeNumbers":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"integer",
                        "format":"int32"
                    }
                },
                "typeNumbersArray":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Object"
                    }
                }
            }
        }
    ]
}

Nested Schema : UsageMetricsRs.DVMUsageMetricsRs

Match All

Show Source

• object UsageMetricsRs.DVMUsageMetricsBaseRs
• object UsageMetricsRs.DVMUsageMetricsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageMetricsRs.DVMUsageMetricsBaseRs"
        },
        {
            "type":"object",
            "properties":{
                "numberInUse":{
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : UsageMetricsRs.IntegrationDesignMetricsRs

Type: object

Show Source

• styles: array styles

{
    "type":"object",
    "properties":{
        "styles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageMetricsRs.IntegrationMetricsStyleRs"
            }
        }
    }
}

Nested Schema : UsageMetricsRs.IntegrationStateMetricsRs

Type: object

Show Source

• activation-in-progress-count: integer (int32)
• active-integration-count: integer (int32)
• total-count: integer (int32)

{
    "type":"object",
    "properties":{
        "active-integration-count":{
            "type":"integer",
            "format":"int32"
        },
        "activation-in-progress-count":{
            "type":"integer",
            "format":"int32"
        },
        "total-count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : UsageMetricsRs.IntegrationUsageMetricsRs

Match All

Show Source

• object UsageMetricsRs.IntegrationUsageMetricsBaseRs
• object UsageMetricsRs.IntegrationUsageMetricsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageMetricsRs.IntegrationUsageMetricsBaseRs"
        },
        {
            "type":"object",
            "properties":{
                "intgStyles":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"integer",
                        "format":"int32"
                    }
                },
                "activedMEPs":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"integer",
                        "format":"int32"
                    }
                },
                "activeMEPsArray":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Object"
                    }
                },
                "numberOfMEPTypes":{
                    "type":"integer",
                    "format":"int64"
                },
                "integrationsByAdapters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"integer",
                        "format":"int32"
                    }
                },
                "integrationsByAdaptersArray":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Object"
                    }
                },
                "scheduledIntegrations":{
                    "$ref":"#/components/schemas/UsageMetricsRs.ScheduledIntegrationsMetricsRs"
                }
            }
        }
    ]
}

Nested Schema : UsageMetricsRs.MessageMetricsRs

Type: object

Show Source

• aborted: integer (int64)
• audit-instances-count: integer (int64)
• debug-instances: integer (int64)
• failed: integer (int64)
• production-instances-count: integer (int64)
• success: integer (int64)
• total: integer (int64)
• total-instances-by-updated-time: integer (int64)

{
    "type":"object",
    "properties":{
        "debug-instances":{
            "type":"integer",
            "format":"int64"
        },
        "aborted":{
            "type":"integer",
            "format":"int64"
        },
        "total":{
            "type":"integer",
            "format":"int64"
        },
        "success":{
            "type":"integer",
            "format":"int64"
        },
        "failed":{
            "type":"integer",
            "format":"int64"
        },
        "audit-instances-count":{
            "type":"integer",
            "format":"int64"
        },
        "production-instances-count":{
            "type":"integer",
            "format":"int64"
        },
        "total-instances-by-updated-time":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.MessageSystemUsageRs

Type: object

Show Source

• jms-count: integer (int32)
• oms-count: integer (int32)

{
    "type":"object",
    "properties":{
        "jms-count":{
            "type":"integer",
            "format":"int32"
        },
        "oms-count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : UsageMetricsRs.PackageUsageMetricsRs

Type: object

Show Source

• business-accelerator: integer (int64)
• developed: integer (int64)
• non-pre-built: integer (int64)
• pre-built: integer (int64)
• recipe: integer (int64)
• technical-accelerator: integer (int64)
• total: integer (int64)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int64"
        },
        "pre-built":{
            "type":"integer",
            "format":"int64"
        },
        "non-pre-built":{
            "type":"integer",
            "format":"int64"
        },
        "developed":{
            "type":"integer",
            "format":"int64"
        },
        "business-accelerator":{
            "type":"integer",
            "format":"int64"
        },
        "technical-accelerator":{
            "type":"integer",
            "format":"int64"
        },
        "recipe":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.ProjectStateMetricsRs

Type: object

Show Source

• active: integer (int32)
• configured: integer (int32)
• draft: integer (int32)

{
    "type":"object",
    "properties":{
        "active":{
            "type":"integer",
            "format":"int32"
        },
        "configured":{
            "type":"integer",
            "format":"int32"
        },
        "draft":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : UsageMetricsRs.ProjectTypeMetricsRs

Type: object

Show Source

• business-accelerator: integer (int32)
• developed: integer (int32)
• recipe: integer (int32)
• xba: integer (int32)

{
    "type":"object",
    "properties":{
        "xba":{
            "type":"integer",
            "format":"int32"
        },
        "developed":{
            "type":"integer",
            "format":"int32"
        },
        "recipe":{
            "type":"integer",
            "format":"int32"
        },
        "business-accelerator":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : UsageMetricsRs.ScheduleUsageMetricsRs

Type: object

Show Source

• active: integer (int64)
• in-use: integer (int64)
• stopped: integer (int64)
• total: integer (int64)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int64"
        },
        "in-use":{
            "type":"integer",
            "format":"int64"
        },
        "active":{
            "type":"integer",
            "format":"int64"
        },
        "stopped":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.AdapterCountRs

Type: object

Show Source

• adapter-display-name-map: object adapter-display-name-map
  Additional Properties Allowed: additionalProperties
• market-place-adapter-count: integer (int32)
• pre-installed-adapter-count: integer (int32)
• private-adapter-count: integer (int32)
• total-adapter-count: integer (int32)

{
    "type":"object",
    "properties":{
        "total-adapter-count":{
            "type":"integer",
            "format":"int32"
        },
        "private-adapter-count":{
            "type":"integer",
            "format":"int32"
        },
        "pre-installed-adapter-count":{
            "type":"integer",
            "format":"int32"
        },
        "market-place-adapter-count":{
            "type":"integer",
            "format":"int32"
        },
        "adapter-display-name-map":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : adapter-display-name-map

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : agents-by-group

Type: object

Additional Properties Allowed

Show Source

• integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : UsageMetricsRs.AppInstanceUsageMetricsBaseRs

Type: object

Show Source

• active: integer (int64)
• configured: integer (int64)
• in-progress: integer (int64)
• total: integer (int64)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int64"
        },
        "in-progress":{
            "type":"integer",
            "format":"int64"
        },
        "configured":{
            "type":"integer",
            "format":"int64"
        },
        "active":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.AppInstanceUsageMetricsRs-allOf[1]

Type: object

Show Source

• typeNumbers: object typeNumbers
  Additional Properties Allowed: additionalProperties
• typeNumbersArray: array typeNumbersArray
• used: integer (int64)

{
    "type":"object",
    "properties":{
        "used":{
            "type":"integer",
            "format":"int64"
        },
        "typeNumbers":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "typeNumbersArray":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        }
    }
}

Nested Schema : typeNumbers

Type: object

Additional Properties Allowed

Show Source

• integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : typeNumbersArray

Type: array

Show Source

• Array of: object Object

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Object"
    }
}

Nested Schema : Object

Type: object

Nested Schema : UsageMetricsRs.DVMUsageMetricsBaseRs

Type: object

Show Source

• total: integer (int64)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.DVMUsageMetricsRs-allOf[1]

Type: object

Show Source

• numberInUse: integer (int64)

{
    "type":"object",
    "properties":{
        "numberInUse":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : styles

Type: array

Show Source

• Array of: object UsageMetricsRs.IntegrationMetricsStyleRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageMetricsRs.IntegrationMetricsStyleRs"
    }
}

Nested Schema : UsageMetricsRs.IntegrationMetricsStyleRs

Type: object

Show Source

• name: string
• patterns: array patterns
• total: integer (int32)

{
    "type":"object",
    "properties":{
        "patterns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageMetricsRs.IntegrationPatternItemRs"
            }
        },
        "total":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : patterns

Type: array

Show Source

• Array of: object UsageMetricsRs.IntegrationPatternItemRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageMetricsRs.IntegrationPatternItemRs"
    }
}

Nested Schema : UsageMetricsRs.IntegrationPatternItemRs

Type: object

Show Source

• active: integer (int32)
• configured: integer (int32)
• draft: integer (int32)
• failed: integer (int32)
• name: string
• total: integer (int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "active":{
            "type":"integer",
            "format":"int32"
        },
        "configured":{
            "type":"integer",
            "format":"int32"
        },
        "draft":{
            "type":"integer",
            "format":"int32"
        },
        "failed":{
            "type":"integer",
            "format":"int32"
        },
        "total":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : UsageMetricsRs.IntegrationUsageMetricsBaseRs

Type: object

Show Source

• activated: integer (int64)
• active-app-instance: integer (int64)
• configured: integer (int64)
• failed-activation: integer (int64)
• in-progress: integer (int64)
• total: integer (int64)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int64"
        },
        "in-progress":{
            "type":"integer",
            "format":"int64"
        },
        "configured":{
            "type":"integer",
            "format":"int64"
        },
        "activated":{
            "type":"integer",
            "format":"int64"
        },
        "failed-activation":{
            "type":"integer",
            "format":"int64"
        },
        "active-app-instance":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UsageMetricsRs.IntegrationUsageMetricsRs-allOf[1]

Type: object

Show Source

• activedMEPs: object activedMEPs
  Additional Properties Allowed: additionalProperties
• activeMEPsArray: array activeMEPsArray
• integrationsByAdapters: object integrationsByAdapters
  Additional Properties Allowed: additionalProperties
• integrationsByAdaptersArray: array integrationsByAdaptersArray
• intgStyles: object intgStyles
  Additional Properties Allowed: additionalProperties
• numberOfMEPTypes: integer (int64)
• scheduledIntegrations: object UsageMetricsRs.ScheduledIntegrationsMetricsRs

{
    "type":"object",
    "properties":{
        "intgStyles":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "activedMEPs":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "activeMEPsArray":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        },
        "numberOfMEPTypes":{
            "type":"integer",
            "format":"int64"
        },
        "integrationsByAdapters":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "integrationsByAdaptersArray":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        },
        "scheduledIntegrations":{
            "$ref":"#/components/schemas/UsageMetricsRs.ScheduledIntegrationsMetricsRs"
        }
    }
}

Nested Schema : activedMEPs

Type: object

Additional Properties Allowed

Show Source

• integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : activeMEPsArray

Type: array

Show Source

• Array of: object Object

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Object"
    }
}

Nested Schema : integrationsByAdapters

Type: object

Additional Properties Allowed

Show Source

• integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : integrationsByAdaptersArray

Type: array

Show Source

• Array of: object Object

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Object"
    }
}

Nested Schema : intgStyles

Type: object

Additional Properties Allowed

Show Source

• integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : UsageMetricsRs.ScheduledIntegrationsMetricsRs

Type: object

Show Source

• running: integer (int64)
• stopped: integer (int64)

{
    "type":"object",
    "properties":{
        "running":{
            "type":"integer",
            "format":"int64"
        },
        "stopped":{
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top