Skip to main content

EntrySheetModifyResponse

Response from creating or updating an entry sheet. Returns the full sheet plus validation messages.

response_codeintegerrequired

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
successbooleanrequired

Indicates whether the request was successful (normally true if it's not an error response)

Default value: true
Example: true
uristring<uri-reference>required
Example: /api/v1/entry_sheets/time/0B04998DCD0E45DF9D0EC97EC926D281
idstring

ID of the created or updated sheet

Example: 0B04998DCD0E45DF9D0EC97EC926D281
errorsstring[]

Validation errors that prevented the operation

Example: []
warningsstring[]

Warnings about the operation (does not prevent success)

Example: []
infostring[]

Informational messages

Example: ["Sheet saved successfully"]
statusstring[]

Status messages from the save operation

Example: []
extra_data object

Additional metadata about validation and also provides the submit action for sheets.

actionstring

use submit to submit for approval, otherwise the default save is used. Also available is interim_submit.

submit_with_warningsboolean

use true to request to submit the sheet for approval despite the presence of validation warnings.

has_dvtboolean

Whether Data Validation Tool is installed (usually true).

Example: true
has_dvt_warningsboolean

Whether DVT generated warnings for the sheet.

EntrySheetModifyResponse
{
  "response_code": 200,
  "success": true,
  "uri": "/api/v1/entry_sheets/time/0B04998DCD0E45DF9D0EC97EC926D281",
  "id": "0B04998DCD0E45DF9D0EC97EC926D281",
  "errors": [],
  "warnings": [],
  "info": [
    "Sheet saved successfully"
  ],
  "status": [],
  "extra_data": {
    "action": "string",
    "submit_with_warnings": true,
    "has_dvt": true,
    "has_dvt_warnings": true
  }
}