Security Controls REST API

Home 

Query Input

(???? THIS TOPIC WILL PROBABLY BE REMOVED. ALL CONTENT IS NOW CONTAINED WITHIN EACH INDIVIDUAL API TOPIC ????)

 

The following are common inputs used by many of the functional areas in the REST API. These inputs are contained in a command request and they are used to filter the amount and type of output you receive in the response.

Not all of the input parameters listed here will work with all areas that reference Query Input. See each topic in the API Function section for the common inputs that apply to each area.

Input Model

Name Type Description

Count

 

Int32

Provide the count of items to return. The maximum value is 50.

Example: 10

CreatedByMe

Boolean

If specified, returns the items created by the user.

Example: True

Name

String

If specified, returns the items whose name matches the provided name.

Example: SampleName

OnOrAfter

DateTime

If specified, returns the deployments started on or after the specified date.

Example: 2018-01-27T20:02:33:457Z

OnOrBefore

DateTime

If specified, returns the deployments started on or before the specified date.

Example: 2018-01-27T20:02:33:457Z

Path

String

Gets/sets the path.

Example: ????

Start

Int32

Gets/sets start.

Example: ????

OTHERS TO ADD?

Value?

??


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other