Special HTTP headers in WorkZone
The following is specific to our WorkZone Service OData provider.
| HTTP Header | Understood by | Description | Required |
|---|---|---|---|
| UseLog-Application | * |
Used for logging purposes. Clients should specify a string that identifies the client application. |
Recommended |
| UseLog-Window | * |
Used for logging purposes. Clients should specify a string that identifies where in the client application the request is originating from/destined to. |
Recommended |
| UseLog-Identity | * |
Used for logging purposes. If a client has special requirements for user/machine identification, specify a string that identifies the user/machine. |
Optional |
| UseLog-ClientHost | * |
Used for logging purposes. Can be used in situations where the OData client is a service. Allows the service to pass thru the end users UserHostAddress and UserHostName to be used in logging. |
Optional (introduced in WZCS 2014) |
| OnBehalfOf | * |
Used in special scenarios where the client is a service running under some system account, but should act on behalf of other users. For example, if a service is a mail service composing mails for users with data coming from WorkZone. This option lets the service specify that requests should be made in the context of the recipient of the email. The format of the value must be User={user} |
Optional |
| ArchiveID | POST/PUT: Documents, $value | In setups with multiple archives, the ArchiveID header can be used to specify that the document contents should be stored in another archive than the default archive. | Optional |
| State | POST: Documents |
Is only used when creating new versions of archived document. This header allows the client to specify another value (the default State is ‘UÅ’) for the new versions State property. |
Optional |