Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "f9920a87-06fb-46f9-b3b6-8425e463e196",
"jobs_id": "acb424ac-2cef-4630-b18c-83b070eb261b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2f6729d3-db5c-4b15-ba62-43ca38f3fa82",
"_parent_id": "505c18f9-510b-4824-bd9c-c413d7d7d09f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "20220e08-3f2f-4ff7-977a-10c5635d513d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f2785886-6587-42ca-8c54-d12cc09e624d",
"_parent_id": "0f926cd2-49a6-40e0-9177-4da09cdbe1ef",
"root_parent_id": "33ce06f0-3479-4f87-b277-dcddce89d510",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1d750af1-4fe8-4b58-a36f-39cbdfe70c65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cfd3f267-8031-4b54-9ce6-900c0ddeb8bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64953d19-9494-4590-87fe-7ecbadb46020",
"_parent_code": "sample string 6",
"sales_organization_id": "fb933295-4c0c-4e2a-9a39-8db79bab379e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"equipment_model_id": "a87e8491-65e4-47cc-9d7b-f6da8e75519b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "84b95ebc-7ad3-44f0-b72a-55dfb4b2dcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a51461cb-a9a5-47a2-9765-2792e02b7359",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "556c7bed-7237-4c69-80fe-baaf0e74f883",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2c7db8d4-dfe0-44ad-be57-639994fc5365",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"modified_dateutc": "2026-02-15T04:40:56.2132443+00:00"
},
"equipment_family_id": "fd4421be-4b6c-4106-aee5-dca8c78b6381",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cfd3f267-8031-4b54-9ce6-900c0ddeb8bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64953d19-9494-4590-87fe-7ecbadb46020",
"_parent_code": "sample string 6",
"sales_organization_id": "fb933295-4c0c-4e2a-9a39-8db79bab379e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"date_in_production_since": "2026-02-15T04:40:56.2132443+00:00",
"date_out_of_production_since": "2026-02-15T04:40:56.2132443+00:00",
"date_end_support": "2026-02-15T04:40:56.2132443+00:00",
"sales_organization_id": "9affda6e-cf35-4280-a687-5df6791a9a0e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-02-15T04:40:56.2132443+00:00"
},
"project_status_id": "df8f01eb-eeb2-4437-91f4-721694a74f1a",
"project_status_code": "sample string 10",
"project_status": {
"id": "4cd5c209-1e89-4e13-a1da-95ec0510fdd1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7141795a-d37a-4af8-a494-973e5a923627",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T04:40:56.2132443+00:00"
},
"company_id": "9d5f1099-69bd-4fed-9c7c-fa58e11ab8ee",
"company_code": "sample string 12",
"db_address_id": "cd78590b-f370-4ee1-bf53-11de79e1993a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7bd1b967-b888-4e22-9701-e93801779469",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1504c1f6-b8d1-4ae9-be91-a04913ba69f2",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-02-15T04:40:56.2288683+00:00",
"date_create": "2026-02-15T04:40:56.2288683+00:00",
"date_update": "2026-02-15T04:40:56.2288683+00:00",
"updated_by_user_id": "ae1c654b-ce0b-4518-af68-ac883340108f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-15T04:40:56.2288683+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-02-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-15T04:40:56.2288683+00:00",
"date_last_job": "2026-02-15T04:40:56.2288683+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-15T04:40:56.2288683+00:00",
"modified_dateutc": "2026-02-15T04:40:56.2288683+00:00",
"is_mobile_installation": true
},
"job_type_id": "be346eda-cf79-4d50-bd0f-686923b50761",
"job_type_code": "sample string 7",
"job_type": {
"id": "a5265acd-32d1-44e1-b330-8e3952653d59",
"name": "sample string 2",
"sales_organization_id": "1ba07ec5-b7c2-43bd-ab38-8ab75c8dfebd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-15T04:40:56.2288683+00:00",
"code": "sample string 7"
},
"job_priority_id": "0ff165bb-00a2-4054-bc61-7a0a613b63fe",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08b7984c-1c66-44d9-a6aa-d0f6ebdba104",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "247ac7fd-1682-4b5d-95e7-3011ea467629",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T04:40:56.2288683+00:00"
},
"job_status_id": "d71b704a-8842-49c7-822a-c80173895b69",
"job_status_code": "sample string 11",
"db_address_id": "fef595d0-2a0c-4ab4-8adc-c8cf63477d62",
"contact_id": "93f2edc6-4988-448c-8899-a0dff2b9eff5",
"requested_by_company_id": "be64b784-771c-4bd0-8f2e-faeb7cffe80d",
"requested_by_contact_id": "9637daab-8031-4b55-9da0-2acb1b87ff34",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-02-15T04:40:56.2288683+00:00",
"due_date": "2026-02-15T04:40:56.2288683+00:00",
"date_create": "2026-02-15T04:40:56.2288683+00:00",
"date_update": "2026-02-15T04:40:56.2288683+00:00",
"date_closed": "2026-02-15T04:40:56.2288683+00:00",
"suggested_user_id": "19604067-7dc6-4260-9d7e-b161efcdb978",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "096961cf-310b-4077-be87-7adda2f45272",
"db_language_id": "0a988ce7-fdb6-4eee-8f3e-78b2fb55e7a8",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-02-15T04:40:56.2288683+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c18d0c80-46e3-4523-aa21-cc3e1b5da2ba",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5d07b3d1-efb7-417c-9488-6e6d9fea0742",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "b2ec9aa5-21ec-443a-9569-dd83abd1db73",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-15T04:40:56.2288683+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4a36adf1-2b10-4a2e-be2e-05ebde4e7e0b"
},
"suggested_date_start": "2026-02-15T04:40:56.2288683+00:00",
"skill_id": "0e365ff5-2322-49a1-b1a1-d8287c5c0cab",
"skill_code": "sample string 32",
"skill": {
"id": "961b9b9b-d7ad-4cb6-ac23-e7d083b2dbc5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b64adda3-8476-4457-beae-9a6ff5b8e7a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f782407e-6bce-4b7f-b713-28cdf79f0c7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62acd993-366a-4c6c-8a04-6e31ce9d4942",
"db_currency_id": "eb85c975-46b2-4590-813e-abfca58091d0",
"db_language_id": "fa29601f-68cc-4396-8710-9cb7977a1320",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-02-15T04:40:56.1976223+00:00"
},
"modified_dateutc": "2026-02-15T04:40:56.2288683+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a19832b7-93bb-4d6d-aef1-f71775615e76",
"date_reported_by_company": "2026-02-15T04:40:56.2288683+00:00",
"id2": 36,
"company_id": "63bd146e-8951-46f5-bb72-b5868d631414",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "180eb12d-540a-446b-ae9a-85b9f6b37d1d",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-02-15T04:40:56.2288683+00:00"
},
"work_instruction_details_id": "00288261-e65d-4209-bd13-fd228297ffdb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "18085d4f-a0ef-4b7f-bdca-864356a3efb2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8e53f397-6402-4a61-9217-4fe7b6761f25",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-15T04:40:56.2288683+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "b8b4a1fd-58d3-498d-ace2-c07da39b003e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-15T04:40:56.2444979+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.