Jump to

• Request
• Response

Get service definitions

get

/serviceapi/apm.dataserver/api/v1/services

Retrieve a list of service definitions. For more information see Services.

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer(int32)
  Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
• offset(optional): integer(int32)
  Offset into result set at which to start returning data, useful for paging [default = 0].
• orderBy(optional): string
  Comma-separated list of one or more attributes by which the result set is ordered [default = null]. For more information see Sorting. Use attribute or attribute:asc or attribute:desc. Valid attributes can be found by using Get resource metadata with metadataType = OrderBy and metadataQuery resource = /services
• q(optional): string
  Query clause of one or more predicates to restrict the result set to those objects satisfying the clause [default = null]. For more information see Filtering. Use query like predicates, such as attribute<=value< code>. Multiple predicates should be parenthesized and joined by AND or OR. Valid attributes can be found by using Get resource metadata with metadataType = Filter and metadataQuery resource = /services

Back to Top

Response

Supported Media Types

• application/json

200 Response

Completed successfully. See Status Codes for special HTTP response status codes for operations on Services.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Service
  Information about an Service

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

Nested Schema : Service

Type: object

Information about an Service

Show Source

• asRule: string
  AppServer Rule (required to create service, see @XSERVICE)
• compartmentId(optional): string
• createTime: string
  Create Time (required to create service, see @XSERVICE)
• createTimeMillis(optional): integer(int64)
• deploymentRule: string
  Deployment Rule (required to create service, see @XSERVICE)
• description: string
  Description (required to create service, see @XSERVICE)
• evaluationTimeMillis(optional): integer(int64)
• id(optional): string
• lastEvaluation(optional): string
• lastModified(optional): string
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• meId(optional): string
• modifiedTimeMillis(optional): integer(int64)
• name(optional): string
• owner: string
  Owner (required to create service, see @XSERVICE)
• queryTimeRange(optional): object TimeRange
• sentToOds(optional): boolean
  Default Value: false
• serviceId(optional): string
• serviceName: string
  Service name (required to create service, see @XSERVICE)
• tenantId(optional): integer(int64)
• tenantName(optional): string
• type(optional): string
  Allowed Values: [ "NONE", "SERVICE", "APPLICATION" ]
• version(optional): integer(int64)
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "required":[
        "asRule",
        "createTime",
        "deploymentRule",
        "description",
        "owner",
        "serviceName"
    ],
    "properties":{
        "tenantId":{
            "type":"integer",
            "format":"int64"
        },
        "tenantName":{
            "type":"string"
        },
        "createTimeMillis":{
            "type":"integer",
            "format":"int64"
        },
        "sentToOds":{
            "type":"boolean",
            "default":false
        },
        "compartmentId":{
            "type":"string"
        },
        "lastEvaluation":{
            "type":"string"
        },
        "modifiedTimeMillis":{
            "type":"integer",
            "format":"int64"
        },
        "version":{
            "type":"integer",
            "format":"int64"
        },
        "meId":{
            "type":"string"
        },
        "evaluationTimeMillis":{
            "type":"integer",
            "format":"int64"
        },
        "lastModified":{
            "type":"string"
        },
        "serviceId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "NONE",
                "SERVICE",
                "APPLICATION"
            ]
        },
        "serviceName":{
            "type":"string",
            "description":"Service name (required to create service, see @XSERVICE)"
        },
        "createTime":{
            "type":"string",
            "description":"Create Time (required to create service, see @XSERVICE)"
        },
        "asRule":{
            "type":"string",
            "description":"AppServer Rule (required to create service, see @XSERVICE)"
        },
        "deploymentRule":{
            "type":"string",
            "description":"Deployment Rule (required to create service, see @XSERVICE)"
        },
        "owner":{
            "type":"string",
            "description":"Owner (required to create service, see @XSERVICE)"
        },
        "description":{
            "type":"string",
            "description":"Description (required to create service, see @XSERVICE)"
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Information about an Service"
}

Nested Schema : linkCollection

Type: array

See Links to Related Resources for more information

Show Source

• Array of: object Link
  Information about a Link to a resource

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TimeRange

Type: object

Show Source

• sinceTime(optional): integer(int64)
  Results are returned *since* this timestamp
• timeInMinutes(optional): integer(int64)
• untilTime(optional): integer(int64)
  Results are returned *until* this timestamp

{
    "type":"object",
    "properties":{
        "timeInMinutes":{
            "type":"integer",
            "format":"int64"
        },
        "sinceTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *since* this timestamp"
        },
        "untilTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *until* this timestamp"
        }
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

Nested Schema : Link

Type: object

Information about a Link to a resource

Show Source

• baseUrl(optional): string
  The base URL for the link
• href: string
  The href portion of the link
• post(optional): string
  The post data of the link
• rel: string
  The relationship name of the link

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship name of the link"
        },
        "href":{
            "type":"string",
            "description":"The href portion of the link"
        },
        "baseUrl":{
            "type":"string",
            "description":"The base URL for the link"
        },
        "post":{
            "type":"string",
            "description":"The post data of the link"
        }
    },
    "description":"Information about a Link to a resource"
}

Nested Schema : ErrorMessage

Type: object

An error message

Show Source

• detail: string
  A detailed description of the error
• errorType(optional): string
  Allowed Values: [ "INFO", "WARNING", "VALIDATION", "ERROR" ]

  The error type
• message: string
  The error message

{
    "type":"object",
    "required":[
        "detail",
        "message"
    ],
    "properties":{
        "errorType":{
            "type":"string",
            "description":"The error type",
            "enum":[
                "INFO",
                "WARNING",
                "VALIDATION",
                "ERROR"
            ]
        },
        "message":{
            "type":"string",
            "description":"The error message"
        },
        "detail":{
            "type":"string",
            "description":"A detailed description of the error"
        }
    },
    "description":"An error message"
}

Back to Top