Web Transaction Analysis Configuration v1.0

Resource: wta_webapp

A Web Application

http://{device}/api/npm.wta_config/1.0/wta_webapps/items/{id}

JSON

{
  "advanced_criteria": string,
  "content_values": [ wta_content_value ],
  "description": string,
  "enabled": boolean,
  "id": integer,
  "match": string,
  "name": string,
  "order_number": integer,
  "preferred": boolean,
  "slow_page_threshold": string,
  "tags": string,
  "url_patterns": [
    {
      "url_pattern": string,
      <prop>: any
    }
  ],
  "use_advanced_criteria": boolean,
  "use_content_values": boolean,
  "use_filter": string,
  "use_url_patterns": boolean,
  "vers": integer
}

{
  "advanced_criteria": string,
  "content_values": [ wta_content_value ],
  "description": string,
  "enabled": boolean,
  "id": integer,
  "match": string,
  "name": string,
  "order_number": integer,
  "preferred": boolean,
  "slow_page_threshold": string,
  "tags": string,
  "url_patterns": [
    {
      "url_pattern": string,
      <prop>: any
    }
  ],
  "use_advanced_criteria": boolean,
  "use_content_values": boolean,
  "use_filter": string,
  "use_url_patterns": boolean,
  "vers": integer
}

Property Name	Type	Description	Notes
wta_webapp	<object>	A Web Application
wta_webapp.advanced_criteria	<string>	Advanced criteria expression	Optional;
wta_webapp.content_values	<array of <wta_content_value>>	List of page datums to match	Optional;
wta_webapp.content_values[items]	<wta_content_value>	Page datum used to specify criteria
wta_webapp.description	<string>	Web Application description	Optional;
wta_webapp.enabled	<boolean>	Indicates whether the Web Application is enabled	Optional;
wta_webapp.id	<integer>	Web Application ID (will be assigned)	Optional;
wta_webapp.match	<string>	Specifies how to logically join the criteria	Optional; Values: any, all;
wta_webapp.name	<string>	Web Application name	Optional;
wta_webapp.order_number	<integer>	Order number (will be assigned)	Optional;
wta_webapp.preferred	<boolean>	Indicates whether the Web Application is preferred	Optional;
wta_webapp.slow_page_threshold	<string>	Duration (seconds) after which pages are considered slow	Optional;
wta_webapp.tags	<string>	Web Application tags	Optional;
wta_webapp.url_patterns	<array of <object>>	List of URL patterns to match	Optional;
wta_webapp.url_patterns[items]	<object>
wta_webapp.url_patterns[items]. url_pattern	<string>	URL pattern (use asterisk as wildcard)	Optional;
wta_webapp.url_patterns[items].<prop>	<any>		Optional;
wta_webapp.use_advanced_criteria	<boolean>	Use any advanced criteria?	Optional;
wta_webapp.use_content_values	<boolean>	Use page datums as criteria?	Optional;
wta_webapp.use_filter	<string>	Specify criteria? (otherwise Web Application will contain All Pages)	Optional;
wta_webapp.use_url_patterns	<boolean>	Use URL patterns as criteria?	Optional;
wta_webapp.vers	<integer>	Web Application version number (will be assigned)	Optional;

Links

wta_webapp: delete

Delete a Web Application

DELETE http://{device}/api/npm.wta_config/1.0/wta_webapps/items/{id}

Response Body

On success, the server does not provide any body in the responses.

wta_webapp: get

Retrieve a Web Application

GET http://{device}/api/npm.wta_config/1.0/wta_webapps/items/{id}

Response Body

Returns a wta_webapp data object.

wta_webapp: set

Update a Web Application

PUT http://{device}/api/npm.wta_config/1.0/wta_webapps/items/{id}

Request Body

Provide a wta_webapp data object.

Response Body

Returns a wta_webapp data object.

Resource: wta_webapps

Web Applications

http://{device}/api/npm.wta_config/1.0/wta_webapps

JSON

{
  "rules": [ wta_webapp ]
}

{
  "rules": [ wta_webapp ]
}

Property Name	Type	Description	Notes
wta_webapps	<object>	Web Applications
wta_webapps.rules	<array of <wta_webapp>>	List of Web Applications	Optional;
wta_webapps.rules[items]	<wta_webapp>	A Web Application

Links

wta_webapps: bulk_delete

Bulk delete multiple Web Applications

POST http://{device}/api/npm.wta_config/1.0/wta_webapps/bulk_delete

Request Body

Provide a BulkDeleter data object.

Response Body

Returns a IDList data object.

wta_webapps: create

Create an Web Application

POST http://{device}/api/npm.wta_config/1.0/wta_webapps

Request Body

Provide a wta_webapp data object.

Response Body

Returns a wta_webapp data object.

wta_webapps: get

Retrieve list of Web Applications

GET http://{device}/api/npm.wta_config/1.0/wta_webapps

Response Body

Returns a wta_webapps data object.

wta_webapps: merge

Merge a list of Web Applications into the existing Web Applications

POST http://{device}/api/npm.wta_config/1.0/wta_webapps/merge

Request Body

Provide a wta_webapps data object.

Response Body

Returns a IDList data object.

wta_webapps: move

Reorder the Web Applications

POST http://{device}/api/npm.wta_config/1.0/wta_webapps/move

Request Body

Provide a wta_move_list data object.

Response Body

On success, the server does not provide any body in the responses.

wta_webapps: since

Get a list of Web Applications that have been recently updated

GET http://{device}/api/npm.wta_config/1.0/wta_webapps/since/{time}

Response Body

On success, the server returns a response body with the following structure:

JSON

{
  "webapps": [
    {
      "name": string,
      "rid": integer,
      "updated": integer,
      "wid": integer,
      <prop>: any
    }
  ],
  <prop>: any
}

{
  "webapps": [
    {
      "name": string,
      "rid": integer,
      "updated": integer,
      "wid": integer,
      <prop>: any
    }
  ],
  <prop>: any
}

Property Name	Type	Description	Notes
wta_webapps.links.since.response	<object>
wta_webapps.links.since.response.webapps	<array of <object>>	List of Web Application IDs and corresponding names	Optional;
wta_webapps.links.since.response.webapps [items]	<object>
wta_webapps.links.since.response.webapps [items].name	<string>	Web Application name	Optional;
wta_webapps.links.since.response.webapps [items].rid	<integer>	ID (missing if Web Application is deleted)	Optional;
wta_webapps.links.since.response.webapps [items].updated	<integer>	Timestamp of last update	Optional;
wta_webapps.links.since.response.webapps [items].wid	<integer>	Internal ID (internally assigned and managed)	Optional;
wta_webapps.links.since.response.webapps [items].<prop>	<any>		Optional;
wta_webapps.links.since.response.<prop>	<any>		Optional;

Type: BulkDeleter

Used for performing bulk delete operations

JSON

{
  "delete_all": boolean,
  "delete_ids": IDList,
  <prop>: any
}

{
  "delete_all": boolean,
  "delete_ids": IDList,
  <prop>: any
}

Property Name	Type	Description	Notes
BulkDeleter	<object>	Used for performing bulk delete operations
BulkDeleter.delete_all	<boolean>	Delete all objects in the collection	Optional;
BulkDeleter.delete_ids	<IDList>	A list of IDs
BulkDeleter.<prop>	<any>		Optional;

Type: IDList

A list of IDs

JSON

[
  number
]

[
  number
]

Property Name	Type	Description	Notes
IDList	<array of <number>>	A list of IDs
IDList[items]	<number>

Type: wta_content_value

Page datum used to specify criteria

JSON

{
  "content_type": string,
  "equals": boolean,
  "location": string,
  "name": string,
  "value": string,
  <prop>: any
}

{
  "content_type": string,
  "equals": boolean,
  "location": string,
  "name": string,
  "value": string,
  <prop>: any
}

Property Name	Type	Description	Notes
wta_content_value	<object>	Page datum used to specify criteria
wta_content_value.content_type	<string>	Format of the datum	Optional; Values: soapValue, urlParam, formValue, httpHeader, cookie, regex;
wta_content_value.equals	<boolean>	Indicates whether the value MUST match or MUST NOT match	Optional;
wta_content_value.location	<string>	Location of the datum	Optional; Values: requestHeader, responseHeader, requestBody, responseBody, url, title;
wta_content_value.name	<string>	Name of the datum	Optional;
wta_content_value.value	<string>	Value to compare to	Optional;
wta_content_value.<prop>	<any>		Optional;

Type: wta_move_list

Ordered list of IDs used to specify a new ordering for a move operation

JSON

{
  "order": [
    integer
  ],
  <prop>: any
}

{
  "order": [
    integer
  ],
  <prop>: any
}

Property Name	Type	Description	Notes
wta_move_list	<object>	Ordered list of IDs used to specify a new ordering for a move operation
wta_move_list.order	<array of <integer>>	ID list	Optional;
wta_move_list.order[items]	<integer>
wta_move_list.<prop>	<any>		Optional;