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": "d104735c-9418-4451-8fed-16efe16cdc0d",
"jobs_id": "490287c2-e7e0-41e3-acdf-13b2d2df8a4d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4f38a868-29e7-49c8-8f69-e41bea6ead31",
"_parent_id": "47e03f56-d72f-4a7e-af4b-7a969b50d7cc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "168ac4d7-ef7b-48ee-82ac-80fa2e0534d9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5cbf7a9f-8a78-4045-b9b7-73a6fa95a73e",
"_parent_id": "c68a27b4-be8c-4710-82aa-beaa54a85f31",
"root_parent_id": "fccafa0e-6c7d-4c6f-b889-17c5bfc2c5f3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8626bb9-eec8-4bc3-9927-671168ea1107",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b8d94b38-765b-44a5-859f-cfe20ea62a35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4db89cec-7da9-4191-8731-cf3c49cc0630",
"_parent_code": "sample string 6",
"sales_organization_id": "94d20d37-9357-4736-b46d-960582d2d107",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
},
"equipment_model_id": "8798cdc4-e1cc-43fb-91e6-0177fd680ac6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ef4a0baa-8473-40e7-9260-4dc45898d173",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "69c533db-5d6f-4dd9-80ec-ee861f2326a6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fdae8372-95ba-4ad9-aad2-137609c458cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "10cf7be3-2d92-4287-b426-380bfeb23ecb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
},
"equipment_family_id": "45b4064c-769f-4cad-87e3-7c2fba86f776",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b8d94b38-765b-44a5-859f-cfe20ea62a35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4db89cec-7da9-4191-8731-cf3c49cc0630",
"_parent_code": "sample string 6",
"sales_organization_id": "94d20d37-9357-4736-b46d-960582d2d107",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
},
"date_in_production_since": "2026-09-05T02:25:19.6900471+00:00",
"date_out_of_production_since": "2026-09-05T02:25:19.6900471+00:00",
"date_end_support": "2026-09-05T02:25:19.6900471+00:00",
"sales_organization_id": "752edbf6-829f-4347-b7b7-6403e74fd670",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+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-09-05T02:25:19.6900471+00:00"
},
"project_status_id": "c4a8cddf-807e-4653-8390-065723ecd126",
"project_status_code": "sample string 10",
"project_status": {
"id": "bdc21248-a217-42da-9857-ae8fdafda6cd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fcf8b5a6-7972-4415-856e-1d5e907074db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
},
"company_id": "87c8f0a8-2618-4b26-9acb-cdd190329343",
"company_code": "sample string 12",
"db_address_id": "be77134e-b702-4696-b7f0-b5b6eedde07b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e30cea7a-04d3-4bee-a0e8-26d065c4528a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "27cab04b-b8df-4e9f-b55d-f0f355885e27",
"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-09-05T02:25:19.6900471+00:00",
"date_create": "2026-09-05T02:25:19.6900471+00:00",
"date_update": "2026-09-05T02:25:19.6900471+00:00",
"updated_by_user_id": "9d919bcd-f8aa-4ae9-92a5-c460075ce5a8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T02:25:19.6900471+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-09-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T02:25:19.6900471+00:00",
"date_last_job": "2026-09-05T02:25:19.6900471+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T02:25:19.6900471+00:00",
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00",
"is_mobile_installation": true
},
"job_type_id": "8e9156be-3033-4514-a075-ea03959cedfa",
"job_type_code": "sample string 7",
"job_type": {
"id": "02715762-4554-4929-886b-5a553bece890",
"name": "sample string 2",
"sales_organization_id": "e7b38d9c-0069-477c-ab51-82e3e7eb9ac0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00",
"code": "sample string 7"
},
"job_priority_id": "e53be2bf-9f1a-4dbf-99a8-71fd7e6bd8d0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b88369bd-99be-4cfc-bfba-cd1944e61ea4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "41711f0f-3894-4aef-9408-212f74d562ce",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
},
"job_status_id": "9bda0bb8-8f7f-45d8-a6ac-e02adb56e92d",
"job_status_code": "sample string 11",
"db_address_id": "f544335c-8dc3-4e20-9d84-ea8f0d201399",
"contact_id": "1c8c3b7c-f22a-4f09-b7c2-d654fc63e3ce",
"requested_by_company_id": "07d7788e-fc4a-4179-8fbb-8cdc98f47263",
"requested_by_contact_id": "6d302c9e-76e3-42db-8c2c-172dbb031ff8",
"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-09-05T02:25:19.6900471+00:00",
"due_date": "2026-09-05T02:25:19.6900471+00:00",
"date_create": "2026-09-05T02:25:19.6900471+00:00",
"date_update": "2026-09-05T02:25:19.6900471+00:00",
"date_closed": "2026-09-05T02:25:19.6900471+00:00",
"suggested_user_id": "bf2e2a0b-9f7f-4c8a-b6dd-5d0d0c3163d6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a9cabd4a-e10a-4c35-b1e2-d7342357e922",
"db_language_id": "a06049ee-42d0-4535-b147-17a250865022",
"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-09-05T02:25:19.6900471+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "38ad4b95-3abf-4f46-8771-dae31c882e8b",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "64bcbc7d-2b2a-46bc-9fbf-f8eb02fd060b",
"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": "ee746fed-c44f-45d2-9856-e9969eb60bf3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "589e6641-e029-4624-bff6-cb756a880920"
},
"suggested_date_start": "2026-09-05T02:25:19.6900471+00:00",
"skill_id": "3b77037a-63a8-4d34-ab88-7468a697b63a",
"skill_code": "sample string 32",
"skill": {
"id": "4f4b872f-2c71-42a5-955a-50897535708a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "85cf84f9-38eb-40eb-be50-31bf9210d5d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "81428b45-ba19-4769-aaaf-15a4188ec95b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1062f49-c33b-4239-ae3e-44b70c22bd47",
"db_currency_id": "f295c28f-102c-4769-b05c-9d9bbebbd9c4",
"db_language_id": "0ab4ce4f-3629-4318-8a29-b98d26b35e7e",
"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-09-05T02:25:19.6900471+00:00"
},
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "05e0a9f1-9c5d-4366-92b8-247d7dbf3a25",
"date_reported_by_company": "2026-09-05T02:25:19.6900471+00:00",
"id2": 36,
"company_id": "2825fe1a-b315-488c-88c9-8bdbdc0f26dd",
"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": "5fab0022-dd68-46d5-a728-528ea57da5c5",
"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-09-05T02:25:19.6900471+00:00"
},
"work_instruction_details_id": "fce5c445-744a-4021-babb-949c24d2afe5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d9e35950-bd73-47a8-a9a0-ca1cfdc41392",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "46a7ef12-5a79-41e6-8531-03f0bc60d509",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T02:25:19.6900471+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": "b0fbef3a-04aa-4cad-9238-81f15ec1d954",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T02:25:19.6900471+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.