Additional Information

instructionType (Mandatory)

String

subClass (Mandatory)

String

status (Mandatory)

String

Specifies the status of an instruction. The following list provides the list of statuses and the corresponding status codes:

• Unpublished - 1
• Published - 2
• In revision - 3

activityCode (Mandatory)

String

Specifies an activity code for a primary action performed as part of the instruction.

For more information, see the Activity Codes table.

Title (Mandatory)

String

Specifies the title of an instruction.

instructionDescription (Optional)

String

Specifies a detailed description for an instruction.

duration (Mandatory)

Double

Specifies the expected time required to execute an instruction. You can use this field when you create a planned maintenance instruction.

durationUnit (Mandatory)

String

Specifies the unit of time for the duration. You can use this field when you create a planned maintenance instruction.

For more information, see the Duration Unit and Codes table.

peopleRequired (Optional)

Integer

Specifies the number of people required to execute the instruction.

documentID in documentIDList at the instructionHeader level (Optional)

String

Specifies the document ID that you can assign at the instruction header level.

For a list of supported MIME types, see the Supported MIME Types for Attachments table.

documentID in vdsDocumentIDList at the instructionHeader level (Optional)

String

Specifies the document ID of a 3D visual file that you want to assign at an instruction header level.

documentID in documentIDList at the steps level (Optional)

String

Specifies the document ID of an image file or a 3D visual that you want to assign at an instruction header level.

documentID at the steps level (Optional)

String

Specifies the document ID that you want to assign to a step.

For a list of supported mime types, see Table Supported MIME Types for Attachments.

failureCode (Mandatory)

String

Specifies failure codes that define different methods in which an item of equipment, or a model might breakdown. These codes are based on ISO standards and you can use them when you create a breakdown instruction.

For more information on various failure mode codes, see the Failure Codes table.

frequency (Mandatory)

Integer

Specifies the frequency at which the instruction must be executed. You can use this field when you create a planned maintenance instruction.

frequencyUnit (Mandatory)

String

Specifies the unit of time for the frequency

criticality (Mandatory)

String

Specifies how important an instruction is for the general maintenance and reliability of an item of equipment. You can use this field when you create a planned maintenance instruction.

postCheckDescription (Optional)

String

Specifies the post checks to be performed after executing an instruction.

ruleCode (Optional)

String

Specifies the safety rule code that you can assign to an instruction.

For more information, see the Safety Rule Codes table.

stepName (Mandatory)

String

Specifies the name of a step in an instruction.

stepDescription (Optional)

String

Specifies the step description for an instruction.

riskCategory (Optional)

String

Specifies the level of potential harm to the environment or injury to the user when you carry out a step in an instruction. The following list contains the list of risk categories and the corresponding codes:

• Low - 1
• Medium - 2
• High - 3

riskDescription(Optional)

String

Specifies a risk description.

roleCode (Optional)

String

Specifies the role code that corresponds to the role that you require to execute a step in an instruction.

For more information, see the Role Codes table.

sparePartID (Optional)

String

Specifies the spare part ID.

quantity (Optional)

Double

Specifies the quantity for a spare part.

toolName (Optional)

String

Specifies the name of the tool required to perform an instruction.

modelID (optional)

String

Specifies the ID of the model assigned to the instruction.

updateDeleteFlag

String

Specifies if you can update or delete the steps, preconditions, attachments, or post checks in an instruction.

Possible values include ‘u’ for update and ‘d’ for delete.

assignUnassignFlag

String

Specifies whether you can assign a model o an instruction or remove an assignment of a model from an instruction. Also, specifies whether you can assign an attachment to a step in an instruction, or remove an assignment of a step in an instruction.

Possible values include ‘a’ for assign and ‘ua’ for removing an assignment.

durationUnit

1

Minutes

2

Hours

3

Days

4

Weeks

5

Months

6

Years

roleCode

1

Heavy Equipment Technician

2

Maintenance Technician

3

Electrical Technician

4

Electric Line Worker

5

Maintenance Helper

6

Welder-Fitter

7

Diver

8

Crane Operator

9

Heavy Equipment Operator

10

Health and Safety Advisor

11

Instrument Technician

12

Maintenance Supervisor

13

Marine Engineer

14

Painter/Coater

15

Pipe Fitter

16

Scaffolder

17

Pipeline Inspector

18

Mechanical Inspector

19

Electrical Inspector

20

Instrumentation Inspector

ruleCode

1

Wear a safety helmet

2

Read the safety manual

3

Wear safety overalls

4

Ground connection is required

5

Wear ear protection

6

Wear eye protection

7

Wear safety boots

8

Wear safety gloves

failureCode

FTF

Fail to function

FTO

Fail to open

FTC

Fail to close

DOP

Operation delay

HIO

Output is high

LOO

Output is low