RequestOptions¶
RequestOptions Properties¶
| Property | Type | Required | Default |
|---|---|---|---|
| CustomHeaderFormatTemplate | string |
Optional | |
| PreferNoContent | boolean |
Optional | false |
| RemoveCreatedEntityAfterUpload | boolean |
Optional | false |
| SendEmptyUpdate | boolean |
Optional | false |
| TransactionID | string |
Optional | |
| UnmodifiableRequest | boolean |
Optional | false |
| UpdateMode | string |
Optional | "Merge" |
| UploadCategory | string |
Optional |
CustomHeaderFormatTemplate¶
Only apply to offline application. Defines a custom header format template for a request
- type:
string
PreferNoContent¶
If create/update requests receive no content in the response
- type:
boolean - default:
false
RemoveCreatedEntityAfterUpload¶
Only apply to offline application. If removing the created entity or media resource locally from the offline store after successfully uploaded
- type:
boolean - default:
false
SendEmptyUpdate¶
If no-change update requests are sent to the server
- type:
boolean - default:
false
TransactionID¶
Only apply to offline application. Defines the transaction ID of the request when transaction builder is enabled. If the string value set to 'UseGeneratedID', a generated entity ID will be used as the transaction ID for the request
- type:
string
UnmodifiableRequest¶
Only apply to offline application. if the request is a unmodifiable request. Certain requests may need to be sent as is. For example, imagine an entity which needs to move from one explicit state to another such as NEW, IN PROCESS, SOLUTION PROVIDED, CONFIRMED. For such requests, set 'unmodifiableRequest' to 'true'. Such requests will be left as is (not combined with other requests) by either request queue optimization or when automatically combining requests to fix errors
- type:
boolean - default:
false
UpdateMode¶
If updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics. The string values can be 'Merge' or Replace'
- type:
string - default:
"Merge"
UploadCategory¶
Only apply to offline application. Defines the upload category of the request. If the string value set to 'UseGeneratedID', a generated entity ID will be used as an upload category for the request
- type:
string