Additional Information

Request Payload Information

Field Name

Data Type

Description and Possible Values

caseName (mandatory)

String

Specifies the name of the improvement request.

caseType (mandatory)

String

Specifies the improvement request. Possible values are:

1-Product Improvement

2-Process improvement

3-Maintenance improvement

priority (mandatory)

String

Specifies the case priority. Possible values are:

1-Low

2-Medium

3-High

commercialImpact (optional)

Integer

Commercial risk involved due to the performance issue. Possible values: 0 to 5

safetyImpact

Integer

Safety risk. Possible values: 0 to 5

environmentalImpact

Integer

Possible values: 0 to 5

operationalImpact

Integer

Possible values: 0 to 5

urgency

Integer

Possbile values: 0 to 5

referenceObjectId (mandatory)

String

Specifies the affected Object ID

id (mandatory)

String

Specifies the ID of the improvement case that has to be addressed

finalRecommendation(mandatory/ optional based on the improvement case status)

String

Specify a recommendation. It is mandatory when the improvement case is in the Submitted or In Process states.

requestDescription

String

Specify the nature of the problem.

equipmentList

List of JSON Objects

List of equipment IDs that have a problem.

assigneeId: Equipment ID

isAdded: Flag to determine if equipment is being added or deleted.

If true then equipment was added to case, if false the equipment was deleted from the case.

instructionList

List of JSON Objects

List of instruction IDs that are associated with this improvement case.

assigneeId: Instruction ID

isAdded: Flag to determine if instruction is being added or deleted.

If true, then the instruction is being added to the case. If false, then the instruction is being deleted from the case.

assigneeType: Determines the section of this instruction that is being added.

10: If Request section

11: If Recommendation section

documentList

List of JSON Objects

List of document IDs that are associated with this improvement case.

assigneeId: Improvement case ID

documentID: ID of the document you want to assign

assignUnassignFlag: Flag to determine if the document is being added or deleted.

If true, then the document is being added to the case. If false, then the document is being deleted from the case.

assigneeType: Determines the section to this document that is being added.

10: If Request section

11: If Recommendation section

requestorId (mandatory)

String

ID of the Improvement requestor.

reviewerId (mandatory)

String

ID of the Improvement Reviewer.

processorId (mandatory)

String

ID of the Recommendation Provider

requestType

String

Specifies the type of the Request

dueDate

String

Specifies the approximate date by which the request needs to handled

referenceObjectType (mandatory)

String

Specifies the type of affected object