OnlineServiceOptions¶
OnlineServiceOptions Properties¶
Property | Type | Required | Default |
---|---|---|---|
avoidInPaths | string |
Optional | |
cacheMetadata | boolean |
Optional | false |
checkQueries | boolean |
Optional | true |
checkResults | boolean |
Optional | true |
checkVersion | boolean |
Optional | false |
createReturnsContent | boolean |
Optional | true |
dataFormat | enum |
Optional | 2 |
dataVersion | enum |
Optional | |
databaseOnly | boolean |
Optional | true |
fixMissingEmptyLists | boolean |
Optional | false |
fixMissingNullValues | boolean |
Optional | false |
ieee754Compatible | boolean |
Optional | false |
logErrors | boolean |
Optional | true |
logWarnings | boolean |
Optional | true |
metadataFile | string |
Optional | "" |
metadataText | string |
Optional | "" |
metadataURL | string |
Optional | "" |
pingAccept | string |
Optional | "application/json, application/xml, application/atomsvc+xml" |
pingMethod | string |
Optional | "GET" |
pingResource | string |
Optional | "/" |
requiresToken | string |
Optional | "X-CSRF-Token" |
requiresType | boolean |
Optional | false |
statefulService | boolean |
Optional | false |
supportsAlias | boolean |
Optional | true |
supportsBatch | boolean |
Optional | true |
supportsBind | boolean |
Optional | true |
supportsDelta | boolean |
Optional | true |
supportsNext | boolean |
Optional | true |
supportsPatch | boolean |
Optional | true |
supportsUnbind | boolean |
Optional | true |
updateReturnsContent | boolean |
Optional | true |
avoidInPaths¶
Characters that must be avoided in the path component of URLs
- type:
string
cacheMetadata¶
Should load the service metadata, cached in a local file? If metadataFile
is non-null, then the cache file name will
be metadataFile
with ".cache" appended. If metadataFile
is null, then the cache file name will be the service name
with ".csdl.cache" appended.
- type:
boolean
- default:
false
checkQueries¶
Check data queries before sending them to the server.
- type:
boolean
- default:
true
checkResults¶
Check query results after receiving them from the server.
- type:
boolean
- default:
true
checkVersion¶
Check version header in OData responses.
- type:
boolean
- default:
false
createReturnsContent¶
Does createEntity return the resulting entity state in response payload?
- type:
boolean
- default:
true
dataFormat¶
Format to be used for data interchange.
- type:
enum
- default:
2
The value of this property must be equal to one of the known values below.
Value | Description |
---|---|
1 |
ATOM |
2 |
JSON |
dataVersion¶
OData version to be used for data interchange.
- type:
enum
The value of this property must be equal to one of the known values below.
Value | Description |
---|---|
100 |
OData v1 |
200 |
OData v2 |
300 |
OData v3 |
400 |
OData v4 |
databaseOnly¶
Is this service only to be used with a local database? By default, a service can be used both online (remote service) and offline (local database).
- type:
boolean
- default:
true
fixMissingEmptyLists¶
If set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail.
- type:
boolean
- default:
false
fixMissingNullValues¶
If set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail.
- type:
boolean
- default:
false
ieee754Compatible¶
Should format parameter IEEE754Compatible enabled
- type:
boolean
- default:
false
logErrors¶
Whether data service error messages are logged.
- type:
boolean
- default:
true
logWarnings¶
Whether data service warning messages are logged.
- type:
boolean
- default:
true
metadataFile¶
Name of local file containing OData CSDL service metadata for the data service.
- type:
string
- default:
""
metadataText¶
Text of the service metadata, provider by the caller so it does not need to be loaded.
- type:
string
- default:
""
metadataURL¶
Alternative location of OData CSDL service metadata.
- type:
string
- default:
""
pingAccept¶
Response type accepted by DataService.pingServer.
- type:
string
- default:
"application/json, application/xml, application/atomsvc+xml"
pingMethod¶
HTTP method used by DataService.pingServer.
- type:
string
- default:
"GET"
pingResource¶
Resource path used by DataService.pingServer.
- type:
string
- default:
"/"
requiresToken¶
Service security token for change requests?
- type:
string
- default:
"X-CSRF-Token"
requiresType¶
Service always requires type metadata in client-sent complex/entity values.
- type:
boolean
- default:
false
statefulService¶
Indicate the service is a stateful service that will return a session information in OData FunctionImports or
ActionImports calls. If set to true, the session information returned from the CallFunction API will be automatically
stored in #Application/#ClientData/#Property:Session/#Property:[SessionPropertyName] for subsequent use in actions or
rules. e.g. #Application/#ClientData/#Property:Session/#Property:SessionID
- type:
boolean
- default:
false
supportsAlias¶
Support parameter aliases?
- type:
boolean
- default:
true
supportsBatch¶
Support OData batch requests?
- type:
boolean
- default:
true
supportsBind¶
Service support bind operations
- type:
boolean
- default:
true
supportsDelta¶
Service support server-side change tracking
- type:
boolean
- default:
true
supportsNext¶
Service support the following of next-links using the $skiptoken system query option.
- type:
boolean
- default:
true
supportsPatch¶
Service support OData PATCH requests (or MERGE for OData versions < 3.0).
- type:
boolean
- default:
true
supportsUnbind¶
Service support unbind operations (unbind navigation property from an existing entity in delete)?
- type:
boolean
- default:
true
updateReturnsContent¶
Do updateEntity calls return resulting entity state in response payload?
- type:
boolean
- default:
true