Request Information

URI Parameters

None.

Body Parameters

The bulk run request.

BulkRunRequest
NameDescriptionTypeAdditional information
Description

Gets or sets the run description.

 string

None.
Query

Gets or sets the SQL query that selects the app ids to run.

 string

None.
Type

Gets or sets the run type.

 BulkRunType

None.

Request Formats

application/json, text/json

Sample: 
{
  "Description": "sample String 1",
  "Query": "sample String 2",
  "Type": "Matrix"
}

text/html

Sample: 
{"Description":"sample String 1","Query":"sample String 2","Type":"Matrix"}

application/xml, text/xml

Sample: 
<BulkRunRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Description>sample String 1</Description>
  <Query>sample String 2</Query>
  <Type>Matrix</Type>
</BulkRunRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An RPC response containing the new bulk run identifier.

RPCResponse
NameDescriptionTypeAdditional information
data

Gets or sets the data.

 Object

None.
errors

Gets or sets the errors.

 Collection of RPCError2

None.
included

Gets or sets the included.

 Collection of Object

None.
messages

Gets or sets the errors.

 Collection of string

None.
modelId

Gets or sets the model identifier.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "data": {},
  "errors": [
    {
      "code": "DataValidation",
      "detail": "sample String 1",
      "id": "sample String 2",
      "status": 100,
      "title": "sample String 3"
    },
    {
      "code": "DataValidation",
      "detail": "sample String 1",
      "id": "sample String 2",
      "status": 100,
      "title": "sample String 3"
    }
  ],
  "included": [
    {},
    {}
  ],
  "messages": [
    "sample String 1",
    "sample String 2"
  ],
  "modelId": 1
}

text/html

Sample: 
{"data":{},"errors":[{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"},{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"}],"included":[{},{}],"messages":["sample String 1","sample String 2"],"modelId":1}