Get application definition by name
get
/serviceapi/apm.dataserver/api/v1/applications/{applicationName}
Retrieve the application definition object for a known application name. For more information see Applications.
Request
Supported Media Types
- application/json
Path Parameters
-
applicationName: string
Name of an application (see Get application definitions or similar). For more information about named path parameters see Object ID Parameters.
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
orattribute:asc
orattribute:desc
. Valid attributes can be found by using Get resource metadata withmetadataType
=OrderBy
andmetadataQuery
resource =/applications
-
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
orOR
. Valid attributes can be found by using Get resource metadata withmetadataType
=Filter
andmetadataQuery
resource =/applications
=value<>
Response
Supported Media Types
- application/json
200 Response
Completed successfully. See Status Codes for special HTTP response status codes for operations on Applications.
Root Schema : Application
Type:
object
Information about an Application
Show Source
-
applicationName:
string
Application name (required to create application, see Applications)
-
applicationRules:
array applicationRules
Application rules (required to create application, see Applications)
-
createTime(optional):
string
-
createTimeMillis(optional):
integer(int64)
-
evaluationTime(optional):
string
-
evaluationTimeMillis(optional):
integer(int64)
-
id(optional):
string
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
meId(optional):
string
-
name(optional):
string
-
queryTimeRange(optional):
object TimeRange
-
sentToOds(optional):
boolean
Default Value:
false
-
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
Nested Schema : applicationRules
Type:
array
Application rules (required to create application, see Applications)
Show Source
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
Nested Schema : TimeRange
Type:
Show Source
object
-
sinceTime(optional):
integer(int64)
Results are returned *since* this timestamp
-
timeInMinutes(optional):
integer(int64)
-
untilTime(optional):
integer(int64)
Results are returned *until* this timestamp
Nested Schema : warnings
Type:
array
Informational or Error messages
Show Source
-
Array of:
object ErrorMessage
An error message
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
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