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": "6e4af329-60da-4c94-8ca6-6c5b8522eef5",
"jobs_id": "3271c428-9084-4bf3-9a5c-c0de158a225c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "00702aad-601d-4a36-8f20-6a3fd547cd02",
"_parent_id": "f78c5cdd-de1e-4511-a9f7-5545f794c627",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b7d19e4f-07de-4f9e-95ca-1ea003ba3992",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e88d49e2-8a77-48ea-9098-34de0e63441e",
"_parent_id": "33597480-0417-4f99-9a11-9fd75648010e",
"root_parent_id": "3eddf94d-b229-42cb-8c51-562850828769",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c9e1be53-c175-43e0-ad00-486fe8ec6d2c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "03577cee-c049-4849-96d2-08436fd7d148",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85226ccf-f155-413d-88e7-e2853250cc9e",
"_parent_code": "sample string 6",
"sales_organization_id": "50162670-424b-4711-9dcf-acb5c2ab5ade",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
},
"equipment_model_id": "81f73dba-c5bb-4a09-a9d5-5228ed1ec2ff",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e20d6df2-55c7-48e0-89de-b5d6353c14c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "813f2a45-48bb-401b-b487-6bb73a466213",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "812a974f-ddec-42ae-9c84-73090e65bfb5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "127b2045-3758-49a0-9415-238b24556669",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
},
"equipment_family_id": "8db13355-64a2-4f9c-8ca2-e00d6a29dd8a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "03577cee-c049-4849-96d2-08436fd7d148",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85226ccf-f155-413d-88e7-e2853250cc9e",
"_parent_code": "sample string 6",
"sales_organization_id": "50162670-424b-4711-9dcf-acb5c2ab5ade",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
},
"date_in_production_since": "2026-05-21T16:00:00.3010973+00:00",
"date_out_of_production_since": "2026-05-21T16:00:00.3010973+00:00",
"date_end_support": "2026-05-21T16:00:00.3010973+00:00",
"sales_organization_id": "05f0cec4-cd8d-49e0-94ac-6d571de1603b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+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-05-21T16:00:00.3010973+00:00"
},
"project_status_id": "3db5102a-115d-459b-b8ee-0e9ec080950a",
"project_status_code": "sample string 10",
"project_status": {
"id": "64fba71c-d89f-4fb4-ab01-ded54cd9edaa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8a17a96-3c0c-4fd8-9eca-495336ff8636",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
},
"company_id": "3bf48967-d350-403c-9248-1b280646ff6f",
"company_code": "sample string 12",
"db_address_id": "d9c8337a-1851-4c3a-8f27-0c2aa26119a5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "52d1b300-a1ea-4413-a1b9-5478d13f50ab",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "66cc5d16-f690-4bd4-9a5a-f956c2023379",
"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-05-21T16:00:00.3010973+00:00",
"date_create": "2026-05-21T16:00:00.3010973+00:00",
"date_update": "2026-05-21T16:00:00.3010973+00:00",
"updated_by_user_id": "943b6938-7b78-44fe-b725-311b0f5ac6fb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T16:00:00.3010973+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-05-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T16:00:00.3010973+00:00",
"date_last_job": "2026-05-21T16:00:00.3010973+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T16:00:00.3010973+00:00",
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00",
"is_mobile_installation": true
},
"job_type_id": "4da1d580-5b9d-4070-b157-2bd990223229",
"job_type_code": "sample string 7",
"job_type": {
"id": "30fae7b3-a75a-4d09-aa96-6923b18ed0a4",
"name": "sample string 2",
"sales_organization_id": "ad7eb6d7-8227-494f-9e80-8ec20835e79a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00",
"code": "sample string 7"
},
"job_priority_id": "39cded87-599c-402b-9d0b-8ce8ea298c69",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3813aa92-8620-4928-b440-2e3d766390f5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "812ba56c-cd62-46a1-8761-7d44d495e0e6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
},
"job_status_id": "241c6798-6010-4a87-8d2e-9a8c867aea30",
"job_status_code": "sample string 11",
"db_address_id": "e5795af3-146e-47d6-a45e-fdd6d963eb7d",
"contact_id": "e95a0108-8ff5-487f-93c7-342ef8d17e27",
"requested_by_company_id": "a9f4abf0-34c6-4e8f-bb12-ce995c1ac680",
"requested_by_contact_id": "07b1f4ea-4302-4abc-8f5d-cb153da0cc00",
"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-05-21T16:00:00.3010973+00:00",
"due_date": "2026-05-21T16:00:00.3010973+00:00",
"date_create": "2026-05-21T16:00:00.3010973+00:00",
"date_update": "2026-05-21T16:00:00.3010973+00:00",
"date_closed": "2026-05-21T16:00:00.3010973+00:00",
"suggested_user_id": "c3f59c5c-3446-420a-b3a9-6a1ebe075e70",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c811a80f-398e-406c-af35-1e9adf50930d",
"db_language_id": "e0eadef9-cf27-41f7-8097-a716d3559f45",
"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-05-21T16:00:00.3010973+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "473da07a-c065-46b0-b914-3a27a528d5ca",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e665c863-0e81-4fd2-8e55-209c575129b3",
"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": "813f5e43-87fd-4ef0-9274-1bc287c6c1ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bad242d0-2aa9-460b-8fba-e1e1941a2225"
},
"suggested_date_start": "2026-05-21T16:00:00.3010973+00:00",
"skill_id": "75d03538-ee1f-4dc7-9b1e-eca86a305de1",
"skill_code": "sample string 32",
"skill": {
"id": "bc94616c-4a12-4009-85c8-a11a1fc14609",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "10a5f063-c1c6-434d-b6cd-12d2c08e7c91",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "332f4b28-fe9d-4fe1-99c3-a2f053b3bad2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aab01d67-7548-4524-b4ff-adaa2c57cdaa",
"db_currency_id": "37fba54e-bded-43da-aaa9-5c227135d938",
"db_language_id": "19cbd73c-39d3-48f6-968c-95e712c07ac2",
"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-05-21T16:00:00.3010973+00:00"
},
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8f654c08-856e-4baf-b76b-1fdce7f8c705",
"date_reported_by_company": "2026-05-21T16:00:00.3010973+00:00",
"id2": 36,
"company_id": "cffbfff0-9e8a-49b7-8e86-b3a6033b8357",
"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": "4be46604-c878-4f59-a82b-f1314460d7df",
"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-05-21T16:00:00.3010973+00:00"
},
"work_instruction_details_id": "31d5b44f-516e-4c40-8b0a-fa42afdc66d3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "744cf6e5-e741-4f18-997f-d3cae4a7ed3e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e65433e-34ca-4d95-b744-e3c5d46b3537",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T16:00:00.3010973+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": "e78447aa-75e1-43d7-88ea-75e65d9ad1a1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T16:00:00.3010973+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.