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": "7ceac9ad-ff63-40f2-bc52-c974461e6f83",
"jobs_id": "2f6effee-e555-4cf0-acf2-f6d2bdbb4eac",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6fe090cb-ab4a-40f9-a66b-1b5401be9683",
"_parent_id": "304b0815-07c3-4cec-88f2-a3ba47fff745",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "785358ee-722b-4c23-968d-711c669c0be7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "014f5dfd-a023-4140-ae11-e5206424c916",
"_parent_id": "9937099a-e6e7-45ea-92de-4e4b62d5146b",
"root_parent_id": "3bba74ff-d67e-4036-9fde-857dc6268559",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "00de4ab6-1cad-4d81-81fc-3de1e8f8d720",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2d22ca94-32d7-4345-8df4-f7b88cf1530d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6752442-755c-4b21-9852-d7c1efc2cdc2",
"_parent_code": "sample string 6",
"sales_organization_id": "e630ce08-ff6b-43ea-a4f1-8b3eeb8a0e9d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"modified_dateutc": "2026-10-08T03:42:12.9915402+00:00"
},
"equipment_model_id": "38f31c9f-e03b-4a73-a9f2-89363bfbf837",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5be5622e-3134-4ced-8d22-124148e2df51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "701479a6-8e69-4c6c-aade-50b8e1031945",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "66c13b63-75fa-4f47-9ca0-407e2dfbcbe3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eb96de80-f831-4c10-952c-b93c9e523345",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"modified_dateutc": "2026-10-08T03:42:13.0084701+00:00"
},
"equipment_family_id": "3ecc08c8-a71f-4b36-8c9d-4e6199f8ec50",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2d22ca94-32d7-4345-8df4-f7b88cf1530d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6752442-755c-4b21-9852-d7c1efc2cdc2",
"_parent_code": "sample string 6",
"sales_organization_id": "e630ce08-ff6b-43ea-a4f1-8b3eeb8a0e9d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"modified_dateutc": "2026-10-08T03:42:12.9915402+00:00"
},
"date_in_production_since": "2026-10-08T03:42:13.0084701+00:00",
"date_out_of_production_since": "2026-10-08T03:42:13.0084701+00:00",
"date_end_support": "2026-10-08T03:42:13.0084701+00:00",
"sales_organization_id": "d6fd1a7b-8f11-41b8-b090-a24021af69c8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+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-10-08T03:42:13.0286054+00:00"
},
"project_status_id": "b0069da1-2df1-434b-b504-b29f475be334",
"project_status_code": "sample string 10",
"project_status": {
"id": "7d08e67a-0d21-4a37-a584-f17b40933726",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8b4e56eb-9d33-4789-b1d6-f69c54376b90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T03:42:13.0286054+00:00"
},
"company_id": "c384d535-f467-4607-8661-e21c2767c31e",
"company_code": "sample string 12",
"db_address_id": "787696e4-d61a-4ee3-84f3-ff2cbcee5ab1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "83f83c72-4cca-4215-8661-83be2331beef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b5418a3b-0fce-45bc-8022-1310640e0ed5",
"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-10-08T03:42:13.038596+00:00",
"date_create": "2026-10-08T03:42:13.038596+00:00",
"date_update": "2026-10-08T03:42:13.038596+00:00",
"updated_by_user_id": "ea881c02-1fc5-4c55-ac19-bb5bff696b87",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T03:42:13.038596+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T03:42:13.038596+00:00",
"date_last_job": "2026-10-08T03:42:13.038596+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T03:42:13.038596+00:00",
"modified_dateutc": "2026-10-08T03:42:13.038596+00:00",
"is_mobile_installation": true
},
"job_type_id": "5d21a581-a401-4ba3-ae78-e666a4f8fb27",
"job_type_code": "sample string 7",
"job_type": {
"id": "a8c0af7c-cb45-4e62-ab5b-b43da192f38d",
"name": "sample string 2",
"sales_organization_id": "b6de03a1-7ca3-4f42-8bd7-13143e5c736d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T03:42:13.038596+00:00",
"code": "sample string 7"
},
"job_priority_id": "c69c6ca2-f2e7-43ed-8ad4-23359ab215d2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "45e81ac8-9066-44f8-bf45-8aa8f9a4f19b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a75d5691-15bd-4105-9389-df424242b86f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T03:42:13.038596+00:00"
},
"job_status_id": "b95c5473-c6c2-44e6-b74a-82729c972c11",
"job_status_code": "sample string 11",
"db_address_id": "40f7ff07-8ea2-4a71-9942-e4ad840c0933",
"contact_id": "a12f3f19-0d02-4887-8775-41da33b4c53e",
"requested_by_company_id": "8b52d19c-1fad-4453-91b7-3098d3dc72bc",
"requested_by_contact_id": "587f6f77-d69e-4a35-8885-7be6d98e587c",
"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-10-08T03:42:13.038596+00:00",
"due_date": "2026-10-08T03:42:13.038596+00:00",
"date_create": "2026-10-08T03:42:13.038596+00:00",
"date_update": "2026-10-08T03:42:13.038596+00:00",
"date_closed": "2026-10-08T03:42:13.038596+00:00",
"suggested_user_id": "a0111dc4-5d6b-4da5-9d52-4eb3e94c8831",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "588290c4-28a0-4305-8add-944ee683e9ae",
"db_language_id": "4452254c-fc48-4a8c-852e-f62c48dbacec",
"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-10-08T03:42:13.038596+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "32d8c4db-0180-4b46-839d-b9d141152769",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0ba5ddff-ffec-416e-9494-d132f1528c75",
"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": "e84f9c2f-8f93-4c2a-8a74-2eabd4dc50da",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T03:42:13.038596+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2ece5c8a-5cb5-437c-b39d-b14da9f4803e"
},
"suggested_date_start": "2026-10-08T03:42:13.038596+00:00",
"skill_id": "f8f0f0a7-d008-43e1-8e5b-cf6b2acbd9d0",
"skill_code": "sample string 32",
"skill": {
"id": "872d541f-24ae-4a79-b3fa-217a261ad2ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0ea15c1b-149b-4c2e-888e-f6bfe7e46c93",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8603339d-7694-4ea4-9c80-431efc1a268f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7e3c2c3-cb05-4666-8f59-c9700db67878",
"db_currency_id": "70f958a6-2b48-4888-9456-980192fc0971",
"db_language_id": "f7369868-775e-4624-a5d4-49fdc3f8931b",
"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-10-08T03:42:12.9915402+00:00"
},
"modified_dateutc": "2026-10-08T03:42:13.038596+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "28cac770-2a57-4824-bc16-d34ef8c31aca",
"date_reported_by_company": "2026-10-08T03:42:13.038596+00:00",
"id2": 36,
"company_id": "1ed1cd37-0813-464b-8c53-277ed70f73b1",
"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": "39144bf0-dc1b-4c10-bf3a-cfb7c39b58d3",
"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-10-08T03:42:13.038596+00:00"
},
"work_instruction_details_id": "05748de2-71f9-403c-987e-0a04f7dce81f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7e809247-9367-4881-8305-44956ea6d996",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "92872911-d1fd-4a3b-821f-d345cc96a965",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T03:42:13.038596+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": "c57e189c-fe4c-4bbd-b86e-531701ccfee6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T03:42:13.038596+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.