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": "7a7b93b1-7906-4d68-a458-f613af25cbe2",
"jobs_id": "a89cb0d4-662e-4b4c-8ac4-1842ceb46f77",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "36da4293-1096-434f-87a5-72683f105cbf",
"_parent_id": "e3119c5b-bd70-4076-bb64-4a9c5ed0cf54",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7b8115dc-819c-4389-8656-9454df0ae21a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ad70d5be-c718-4447-8457-61158d914881",
"_parent_id": "02ce9d84-b12d-4f4a-8d60-f25eb23176b4",
"root_parent_id": "f885adc6-e3d1-4465-812c-81ce14ed0bc8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "81832b15-5c8f-4a8f-a2d2-6a59642dfe5a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b8520713-75b0-432e-b00e-91c6bef10448",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f95e4f82-9cca-45e1-a7ab-10e26437452e",
"_parent_code": "sample string 6",
"sales_organization_id": "e1ae43e7-5c3b-46c1-9cd4-32f5a7e10c46",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00"
},
"equipment_model_id": "78c27ef0-e5b7-44d9-b341-c9fcbf40f0ab",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a783dd0e-f456-4a3b-9e20-c57de654a596",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "86e3bf48-0530-4eaf-ab55-afc82afc664a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cbdb2d64-8e14-4b2f-81e9-6e2398bc5ffd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eb2f9afe-f084-4560-8f7e-38665ec882a0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00"
},
"equipment_family_id": "a39c3479-9432-4703-8934-fcae4d11e691",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b8520713-75b0-432e-b00e-91c6bef10448",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f95e4f82-9cca-45e1-a7ab-10e26437452e",
"_parent_code": "sample string 6",
"sales_organization_id": "e1ae43e7-5c3b-46c1-9cd4-32f5a7e10c46",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00"
},
"date_in_production_since": "2026-11-14T08:58:29.4369212+00:00",
"date_out_of_production_since": "2026-11-14T08:58:29.4369212+00:00",
"date_end_support": "2026-11-14T08:58:29.4369212+00:00",
"sales_organization_id": "c2d487c6-9d3a-4033-afae-74d5d6568502",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+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-11-14T08:58:29.4369212+00:00"
},
"project_status_id": "08468d24-a612-41df-ac5b-173b04145257",
"project_status_code": "sample string 10",
"project_status": {
"id": "2b93f703-d2c9-4f34-a72e-dc11e4b7d005",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "367c5e23-e80a-4b4d-b621-7b8c290e774d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00"
},
"company_id": "1c7a0397-19b5-48a7-8c47-4f25367ca654",
"company_code": "sample string 12",
"db_address_id": "cd2e3d92-c7d2-4198-a157-19e44fb238f1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9144e0ec-0cdb-4835-802c-b88194a16dad",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7a863add-b630-4294-9b2c-61b1cc2e6135",
"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-11-14T08:58:29.4369212+00:00",
"date_create": "2026-11-14T08:58:29.4369212+00:00",
"date_update": "2026-11-14T08:58:29.4369212+00:00",
"updated_by_user_id": "a38bb71c-b3eb-4d2e-9da0-f4743a65f01e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-14T08:58:29.4369212+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-11-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-14T08:58:29.4369212+00:00",
"date_last_job": "2026-11-14T08:58:29.4369212+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-14T08:58:29.4369212+00:00",
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00",
"is_mobile_installation": true
},
"job_type_id": "253d4dee-b291-4c0f-b0e4-6a70d0b4add8",
"job_type_code": "sample string 7",
"job_type": {
"id": "0e8ea885-4695-4acf-a3e5-7fb53f79e015",
"name": "sample string 2",
"sales_organization_id": "e800d82b-e63d-4466-9ce5-31d182e84ee3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00",
"code": "sample string 7"
},
"job_priority_id": "ea7e13a3-0e63-4349-8afe-5cd659726ddf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c956f78f-c105-4b0c-b100-13de8e13be73",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a3cf1e60-fcbb-4ba2-a703-de273029f7c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00"
},
"job_status_id": "4b64168c-c5be-4128-a9c3-0deacb5893b7",
"job_status_code": "sample string 11",
"db_address_id": "851a3692-39d6-4d78-827d-88f8d9abc7e5",
"contact_id": "7ab901eb-5e9e-47b9-9ef7-b0181d9b4458",
"requested_by_company_id": "89ae279e-6fc5-4db6-9d18-78c2b77868d4",
"requested_by_contact_id": "a3a824bb-958d-4769-a710-ee0662ee160a",
"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-11-14T08:58:29.4369212+00:00",
"due_date": "2026-11-14T08:58:29.4369212+00:00",
"date_create": "2026-11-14T08:58:29.4369212+00:00",
"date_update": "2026-11-14T08:58:29.4369212+00:00",
"date_closed": "2026-11-14T08:58:29.4369212+00:00",
"suggested_user_id": "1a591e83-aa6f-4742-8741-ebd1860e77e9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f00b5fe7-0073-46cb-bb5d-36ee029c2254",
"db_language_id": "f7d5b2aa-0b36-4c12-ba95-9a11e72d8655",
"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-11-14T08:58:29.4369212+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3d5b5a5-cee6-44e5-a38c-253742d862be",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3de37ce3-4d5f-4d98-8121-99084ff1367f",
"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": "d64c14b4-9853-4e46-9bfd-66f5797d3c0c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aba15510-6efc-4141-95ae-8c5511a8bab2"
},
"suggested_date_start": "2026-11-14T08:58:29.4369212+00:00",
"skill_id": "bc2c968e-25bd-46a9-9475-3ecadb15fcc8",
"skill_code": "sample string 32",
"skill": {
"id": "cfd56cc9-66da-492b-a090-fe153641ed95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bc892d9f-8ff5-47e6-a0f8-209fdc83a4f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27626a59-d7e3-4b11-aba4-e92c44642d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7b98947-b26f-4bcc-98ad-ca8c30c8b4ba",
"db_currency_id": "aff9fa2f-2f19-4929-b304-05d5c10b1413",
"db_language_id": "e85b2f93-c3ff-4266-9a30-c4b354ca49c4",
"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-11-14T08:58:29.4369212+00:00"
},
"modified_dateutc": "2026-11-14T08:58:29.4369212+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "052e2485-351d-4df6-b830-4ee54a94982a",
"date_reported_by_company": "2026-11-14T08:58:29.4369212+00:00",
"id2": 36,
"company_id": "eb9d7458-4401-419d-8cfb-3aef4a3c8587",
"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": "320b621e-0157-4104-83f5-65dfdc19ab64",
"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-11-14T08:58:29.4369212+00:00"
},
"work_instruction_details_id": "18253eea-b9ad-4cff-9bbe-733897da0180",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "30b8ac36-e0a1-4973-9065-081baa6911fc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ea4f29ab-cf93-4dd3-81b2-f337288de574",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-14T08:58:29.4369212+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": "af16f07c-9bf3-418b-9bcc-fd0988716c46",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-14T08:58:29.4483891+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.