Versions Compared

Old Version 11

changes.mady.by.user Cam Mackay

Saved on

compared with

New Version Current

changes.mady.by.user Bao TRINH

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Provides access to Datasheet related data.

Endpoints

The resources available in this module.

DatasheetListApi

Overview

Provides access to Datasheet related data.

Endpoints

The resources available in this module.

DatasheetListApi

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

/api/DatasheetListApi

Method

Description

Performed As

Request Query

Request Body

Response

POST

Retrieve a filtered list of datasheets.

Logged in User

-

GridRequestParametersApi

GridResult<DatasheetModelLine>

PUT

Create a new Datasheet

Logged in User

-

DatasheetDialogFields

SaveResult

DatasheetTemplateListApi

Provides API access to the Datasheets Datasheet Templates List (#/Datasheets/ListTemplateList.aspx) Web Workbench screen.

/api/

DatasheetListApi

DatasheetTemplateListApi

Method

Description

Performed As

Request Query

Request Body

Response

POST

GET

Retrieve a

filtered

list of

datasheets

datasheet templates.

Logged in User

DatasheetTemplateFilter

-

GridRequestParametersApi

GridResult<

DatasheetModelLine

DatasheetTemplateLine>

PUT

POST

Create a new Datasheet

Retrieve a filtered list of datasheet templates.

Logged in User

-

DatasheetDialogFields

SaveResult

DatasheetTemplateListApi

GridRequestParametersApi

GridResult<DatasheetTemplateLine>

DatasheetDetailApi

Provides API access to the Datasheet Templates List Entry (#/Datasheets/TemplateListMyList.aspx/Edit) Web Workbench screen.

/api/

DatasheetTemplateListApi

DatasheetDetailApi

Method

Description

Performed As

Request Query

Request Body

Response

GET

Retrieve a

list of datasheet templates.

specific Datasheet

Logged in User

DatasheetTemplateFilter

DatasheetKey

-

GridResult<DatasheetTemplateLine>

DatasheetApiModel

POST

Retrieve a filtered list of datasheet templates.

Update a Datasheet

Logged in User

-

DatasheetApiModel

GridRequestParametersApi

GridResult<DatasheetTemplateLine>

DatasheetDetailApi

Provides API access to the Datasheet Entry (#/Datasheets/MyList.aspx/Edit) Web Workbench screen.

/url

Method

Description

Performed As

Request Query

Request Body

Response

GET

Retrieve a specific Datasheet

Logged in User

DatasheetKey

-

DatasheetApiModel

POST

Update a Datasheet

Logged in User

-

DatasheetApiModel

DatasheetApiModel

Models

The definitions of models specific to endpoints in this module.

DatasheetKey

Field

Type

Description

DatasheetID

Integer

The unique Datasheet ID of the Datasheet

DatasheetTemplateFilter

Field

Type

Description

KeyTable

string

Filters the templates.

Must be one of the following: Jobs, PlantItems, Companies, People, SubContracts, All, Logs, SubContractClaims, Docket 

KeyString

string

If specified, the response will include relatedDatasheetsCount.

KeyInt

int

If specified, the response will include relatedDatasheetsCount.

DatasheetApiModel

Models

The definitions of models specific to endpoints in this module.

DatasheetKey

Field

Type

Description

DatasheetID

Integer

The unique Datasheet ID of the Datasheet

⬆️ Back to top

DatasheetModelLine

Field

Type

Description

Key

DatasheetKey

The unique key for the line.

Template

CellData

The Datasheet Template for the Datasheet.

Date

String

The Datasheet date.

Name

String

The name of the assignee.

KeyTable

String

The type of document the Datasheet is for.

Subject

String

The subject of the Datasheet.

Rating

Number

The rating of the Datasheet.

Complete

Boolean

Completed or not.

JSON

String

A JSON representation of the Datasheet, including questions.

⬆️ Back to top

DatasheetDialogFields

Field

Type

Description

Date

DateViewData

The Datasheet Date on the new Datasheet.

Template

PickerViewData

The Datasheet Template for the new Datasheet.

Assignee

PickerViewData

The Assignee on the new Datasheet. If null then Assignee will be the Logged in User.

Subject

StringViewData

The subject on the new Datasheet.

Comments

StringViewData

The Comments on the new Datasheet.

Job

PickerViewData

The document which the new Datasheet is for. Only one of these fields should be specified (based on the Key Table on the Datasheet Template).

Plant

PickerViewData

Company

PickerViewData

Person

PickerViewData

SubContract

PickerViewData

SubContractClaim

PickerViewData

Log

PickerViewData

Docket

PickerViewData

Company

PickerViewData

Person

PickerViewData

SubContract

PickerViewData

SubContractClaim

PickerViewData

Log

PickerViewData

Docket

PickerViewData

DatasheetApiModel

⬆️ Back to top

DatasheetTemplateFilter

Field

Type

Description

KeyTable

string

Filters the templates.

Must be one of the following: Jobs, PlantItems, Companies, People, SubContracts, All, Logs, SubContractClaims, Docket 

KeyString

string

If specified, the response will include relatedDatasheetsCount.

KeyInt

int

If specified, the response will include relatedDatasheetsCount.

⬆️ Back to top

DatasheetTemplateKey

Field

Type

Description

Key

DatasheetTemplateID

DatasheetsDatasheetKey

Completed

Boolean

Questions

Array [QuestionViewData]

Headers

HeaderViewData

Fields

Array [FieldViewData]

DatasheetModelLine

Field

Type

Description

Key

DatasheetKey

The unique key for the line.

Template

CellData

The Datasheet Template for the Datasheet.

Date

String

The Datasheet date.

Name

String

The name of the assignee.

KeyTable

String

The type of document the Datasheet is for.

Subject

String

The subject of the Datasheet.

Rating

Number

The rating of the Datasheet.

Complete

Boolean

Completed or not

Integer

The unique ID of the Datasheet Template

⬆️ Back to top

DatasheetTemplateLine

Field

Type

Description

Key

DatasheetTemplateKey

The unique key for the line.

Description

CellData

The description of the Datasheet Template.

Details

String

The details of the Datasheet Template.

KeyTable

String

The type of document the Datasheet Template is for.

DatasheetType

String

The name of the Datasheet Type of the Datasheet Template.

DatasheetTemplateTypeId

Integer

The ID of the Datasheet Type of the Datasheet Template.

Header

CellData

The number of Headers on the Datasheet Template.

Deactivated

Boolean

The Deactivated flag on the Datasheet Template.

DeactivatedValue

CellData

The Deactivated flag on the Datasheet Template.

JSON

String

A JSON representation of the Datasheet Template, including

questions.
DatasheetTemplateKey

the template lines.

⬆️ Back to top

DatasheetApiModel

Field

Type

Description

DatasheetTemplateID

Key

Integer

DatasheetKey

The unique

ID of

key for the Datasheet

Template

Field

Type

Description

Key

DatasheetTemplateKey

The unique key for the line.

Description

CellData

The description of the Datasheet Template.

Details

String

The details of the Datasheet Template.

KeyTable

String

The type of document the Datasheet Template is for.

DatasheetType

String

The name of the Datasheet Type of the Datasheet Template.

DatasheetTemplateTypeId

Integer

The ID of the Datasheet Type of the Datasheet Template.

Header

CellData

The number of Headers on the Datasheet Template.

Deactivated

Boolean

The Deactivated flag on the Datasheet Template.

DeactivatedValue

CellData

The Deactivated flag on the Datasheet Template.

JSON

String

A JSON representation of the Datasheet Template, including the template lines.

.

DatasheetTemplateLine

Completed

BoolViewData

The completed flag on the Datasheet.

Headers

HeaderViewData

The header information on the Datasheet.

Fields

Array<FieldViewData>

All fields on the Datasheet.

Questions

Array<QuestionViewData>

The question fields on the Datasheet.

⬆️ Back to top

HeaderViewData

Field

Type

Description

Headers

Array<FieldViewData>

The header fields without a column.

Columns

Array<HeaderColumnViewData>

The columns of header fields.

⬆️ Back to top

HeaderColumnViewData

Field

Type

Description

ColumnNo

Integer

The column number for these header fields.

Headers

Array<FieldViewData>

The header fields in this column.

⬆️ Back to top

QuestionViewData

Field

Type

Description

QuestionId

Integer

The ID of the Question for this line.

DatasheetLineId

Integer

QuestionId

Integer

Code of the datasheets question

The ID of the Datasheet Template for this line.

TemplateLineId

Integer

The unique ID for this Datasheet line.

Text

String

The text from the Datasheet Template line.

Title

String

The instructions from the Datasheet Template line.

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 answersThe Has Notes flag on the Datasheet Template line.

Required

Boolean

The Required flag on the Datasheet Template line.

Notes

String

The Notes on the Datasheet line.

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

GetClassBoolValue

String

TemplateLineId

Integer

Line id.

Id

String

JsAttrName

String

JsAttrValue

String

Name

String

Visible

Boolean

Disabled

Boolean

Required

Boolean

InfoText

String

Examples

%name

Expand
titleClick to view

Request

Code Block
languagejson

Response

Code Block
languagejson

Response sample

Code Blocklanguagejson

Boolean

These fields contain the response on the Datasheet line.

Based on the type of the Datasheet Question on the Datasheet line.

StringValue

String

DateValue

String

TimeValue

String

IntValue

Integer

DecimalValue

Number

DisplayText

String

SelectList

Array<string>

⬆️ Back to top

Examples

Get the list of datasheets template.

Expand
titleClick to view

Request

Code Block
languagejson
Response
 Code Block
languagejson
{
  "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
languagejson
{
  "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
minLevel1
maxLevel3
outlinefalse
typelist
separatorbrackets
printablefalse
 Include Page
KB1:How-to footer
KB1:How-to footer