/application

Search Applications

get

Performs a full-text search of all applications known to the server. As with other full-text endpoints this allows for pagination and offset.

Authorizations
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
searchanyOptional
Responses
400Error
application/json
get
GET /api/rest/application HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Creates a New Application

post

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

Authorizations
Body
nameanyRequiredPattern: [^_]\w+
descriptionanyOptional
attributesanyOptional
Responses
400Error
application/json
post
POST /api/rest/application HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": null,
  "description": null,
  "attributes": null
}
{
  "code": "text",
  "message": "text"
}

Get an Application

get

Gets the metadata for a single application. This may include more specific details not availble in the bulk-get or fetch operation.

Authorizations
Path parameters
nameOrIdanyRequired
Responses
400Error
application/json
get
GET /api/rest/application/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Updates an Application

put

Performs an update to an existing application known to the server.

Authorizations
Path parameters
nameOrIdanyRequired
Body
nameanyRequiredPattern: [^_]\w+
descriptionanyOptional
attributesanyOptional
Responses
400Error
application/json
put
PUT /api/rest/application/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": null,
  "description": null,
  "attributes": null
}
{
  "code": "text",
  "message": "text"
}

Deletes an Application

delete

Deletes a specific application known to the server.

Authorizations
Path parameters
nameOrIdanyRequired
Responses
400Error
application/json
delete
DELETE /api/rest/application/{nameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}
PreviousAPI SpecificationNext/application/configuration

Last updated