Overview

APIs regarding the Datasheet in WorkbenchProvides access to Datasheet related data.

Endpoints

The resources available in this module.

DatasheetListApi

[Description]Provides API access to the Datasheets List (#/Datasheets/List.aspx) Web Workbench screen.

/api/DatasheetTemplateListApi

Method

/api/DatasheetListApi
Method	Description	Performed As	Request Query	Request Body	Response
POST	-	PUT

DatasheetTemplateListApi

[Description]

Retrieve a filtered list of datasheets.	Logged in User	-	GridRequestParametersApi	GridResult<DatasheetModelLine>
PUT	Create a new Datasheet	Logged in User	-	DialogFields	SaveResult

DatasheetTemplateListApi

[Description]

/api/DatasheetTemplateListApi
Method	Description	Performed As	Request Query	Request Body	Response
GET			-
POST

GET parameters.

Parameter

-

POST

Value

Description

Parameter Type

Data Type

keyTable

One of these:

Jobs
PlantItems
Companies
People
SubContracts
All
Logs
SubContractClaims Docket

query

string

keyString

query

string

keyInt

query

integer

DatasheetDetailApi

[Description]

/url
Method	Description	Performed As	Request Query	Request Body	Response
DELETE			-
GET
POST

GET Parameter

Parameter	Parameter Type	Data Type
datasheetId	query	integer
datasheetTemplateId	query	integer
keyStr	query	string
keyInt	query	integer

Models

The definitions of models specific to endpoints in this module.

DatasheetApiModel

Field	Type	Description
Key	DatasheetsDatasheetKey
Completed	Boolean
Questions	Array [QuestionViewData]
Headers	HeaderViewData
Fields	Array [FieldViewData]

DatasheetsDatasheetKey

Field	Type	Description
DatasheetId	Integer
DatasheetTemplateId	Integer
KeyStr	String
KeyInt	Integer

DatasheetsDatasheetModelLine

Field	Type	Description
Datasheet	CellData
Template	CellData	The template was used for the datasheet.
Date	String	Date of datasheet.
Name	String	Name of datasheet
KeyTable	String	The area the datasheet relates to
Subject	String
Rating	Number
Complete	Boolean	Completed or not.
JSON	String
Status	String
ReadonlyFlag	Integer
OriginalKey	DatasheetsDatasheetKey
CurrentKey	DatasheetsDatasheetKey
Key	DatasheetsDatasheetKey
Index	Integer

DatasheetsTemplateKey

Field	Type	Description
DatasheetTemplateId	Integer

DatasheetsTemplateLine

Field	Type	Description
Description	CellData
Header	CellData
Deactivated	Boolean
DeactivatedValue	CellData
Details	String
KeyTable	String	The area the datasheet relates to
DatasheetType	String
DatasheetTemplateTypeId	Integer
JSON	String
Select	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	DatasheetsTemplateKey
CurrentKey	DatasheetsTemplateKey
Key	DatasheetsTemplateKey
Index	Integer

QuestionViewData

Field	Type	Description
DatasheetLineId	Integer
QuestionId	Integer	Code of the datasheets question
Text	String
Title	String
HasNotes	Boolean
Notes	String
BoolValue	Boolean
StringValue	String
DateValue	String
TimeValue	String
IntValue	Integer
DecimalValue	Number
DisplayText	String	Text that displayed for users.
SelectList	Array [string]	Values of answers.
Type	String	Type of the question. Boolean - Yes / No Text - single line text entry Text - Multi Line - multiple lines of text entry Date and Date Time are indistinguishable on the Questionnaire presented to the User Integer - numbers only Currency and Decimal are indistinguishable on the Questionnaire presented to the User Job Picker - allows user to pick from the /wiki/spaces/SPEC/pages/382403097 Person Picker - allows user to pick from the People List (both internal and external persons) Employee Picker - allows user to pick from a list of employees only Time - time only without the date no date
GetClass	String
TemplateLineId	Integer	Line id.
Id	String
JsAttrName	String
JsAttrValue	String
Name	String
Visible	Boolean
Disabled	Boolean
Required	Boolean
InfoText	String

Examples

%name

Expand

title	Click to view

Request

Code Block

language	json

Response

Code Block

language	json

Response sample

Code Block

language	json

Get the list of datasheets template.

Expand

title	Click to view

Request

Code Block

language	json

Response

Code Block

language	json

{
  "total": 0,
  "page": 0,
  "records": 0,
  "rows": [
    {
      "Description": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-07T21:55:49.386Z",
        "CellValueInt": 0
      },
      "Header": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-07T21:55:49.386Z",
        "CellValueInt": 0
      },
      "Deactivated": true,
      "DeactivatedValue": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-07T21:55:49.386Z",
        "CellValueInt": 0
      },
      "Details": "string",
      "KeyTable": "string",
      "DatasheetType": "string",
      "DatasheetTemplateTypeId": 0,
      "JSON": "string",
      "Select": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-07T21:55:49.386Z",
        "CellValueInt": 0
      },
      "Status": "string",
      "ReadonlyFlag": 0,
      "ReadonlyMessage": "string",
      "OriginalKey": {
        "DatasheetTemplateId": 0
      },
      "CurrentKey": {
        "DatasheetTemplateId": 0
      },
      "Key": {
        "DatasheetTemplateId": 0
      },
      "Index": 0
    }
  ],
  "form": {},
  "widgets": [
    {
      "WidgetId": 0,
      "LayoutCode": "string",
      "Name": "string",
      "Colour": "string",
      "BGColour": "string",
      "Icon": "string",
      "Type": "string",
      "Visible": true,
      "Order": 0,
      "Count": 0,
      "WidgetLines": [
        {
          "WidgetLineId": 0,
          "WidgetId": 0,
          "Name": "string",
          "Predicate": "string",
          "Order": 0,
          "Count": 0
        }
      ]
    }
  ]
}

Response sample

Code Block

language	json

{
  "total": 0,
  "page": 0,
  "records": 0,
  "rows": [
    {
      "Details": "Incident Report",
      "OriginalKey": {
        "DatasheetTemplateId": 1
      },
      "CurrentKey": {
        "DatasheetTemplateId": 1
      },
      "Key": {
        "DatasheetTemplateId": 1
      },
      "Index": 0
    },
    {
      "Details": "Project Handover Checklist",
      "OriginalKey": {
        "DatasheetTemplateId": 3
      },
      "CurrentKey": {
        "DatasheetTemplateId": 3
      },
      "Key": {
        "DatasheetTemplateId": 3
      },
      "Index": 0
    },
    {
      "Details": "Daily Job Sheet",
      "OriginalKey": {
        "DatasheetTemplateId": 9
      },
      "CurrentKey": {
        "DatasheetTemplateId": 9
      },
      "Key": {
        "DatasheetTemplateId": 9
      },
      "Index": 0
    },
    {
      "Details": "Electrical Safety JSA",
      "OriginalKey": {
        "DatasheetTemplateId": 75
      },
      "CurrentKey": {
        "DatasheetTemplateId": 75
      },
      "Key": {
        "DatasheetTemplateId": 75
      },
      "Index": 0
    },
    {
      "Details": "Risk form",
      "OriginalKey": {
        "DatasheetTemplateId": 164
      },
      "CurrentKey": {
        "DatasheetTemplateId": 164
      },
      "Key": {
        "DatasheetTemplateId": 164
      },
      "Index": 0
    },
    {
      "Details": "Edridge Prestart",
      "OriginalKey": {
        "DatasheetTemplateId": 165
      },
      "CurrentKey": {
        "DatasheetTemplateId": 165
      },
      "Key": {
        "DatasheetTemplateId": 165
      },
      "Index": 0
    },
    {
      "Details": "Daily Job Sheet",
      "OriginalKey": {
        "DatasheetTemplateId": 222
      },
      "CurrentKey": {
        "DatasheetTemplateId": 222
      },
      "Key": {
        "DatasheetTemplateId": 222
      },
      "Index": 0
    },
    {
      "Details": "Training form",
      "OriginalKey": {
        "DatasheetTemplateId": 335
      },
      "CurrentKey": {
        "DatasheetTemplateId": 335
      },
      "Key": {
        "DatasheetTemplateId": 335
      },
      "Index": 0
    },
    {
      "Details": "Daily Diary - Job",
      "OriginalKey": {
        "DatasheetTemplateId": 355
      },
      "CurrentKey": {
        "DatasheetTemplateId": 355
      },
      "Key": {
        "DatasheetTemplateId": 355
      },
      "Index": 0
    }
  ],
  "form": {
    "relatedDatasheetsCount": 0
  }
}

⬆️ Back to top

On this page

Table of Contents

minLevel	1
maxLevel	3
outline	false
type	list
separator	brackets
printable	false

Include Page

	KB1:How-to footer
	KB1:How-to footer

Versions Compared

Old Version 3

New Version 4

Key

Overview

Endpoints

DatasheetListApi

DatasheetTemplateListApi

DatasheetTemplateListApi

DatasheetDetailApi

Models

DatasheetApiModel

DatasheetsDatasheetKey

DatasheetsDatasheetModelLine

DatasheetsTemplateKey

DatasheetsTemplateLine

QuestionViewData

Examples

%name

Request

Response

Response sample

Get the list of datasheets template.

Request

Response

Response sample

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Overview

Endpoints

DatasheetListApi

DatasheetTemplateListApi

DatasheetTemplateListApi

DatasheetDetailApi

Models

DatasheetApiModel

DatasheetsDatasheetKey

DatasheetsDatasheetModelLine

DatasheetsTemplateKey

DatasheetsTemplateLine

QuestionViewData

Examples

%name

Request

Response

Response sample

Get the list of datasheets template.

Request

Response

Response sample