Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| appId |
The application identifier. |
integer |
Required |
| notify |
The notification address. |
string |
None. |
| simulate |
The simulation indicator. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
An RPC response indicating if the job was successfully enqueued.
RPCResponse| Name | Description | Type | Additional 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}