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": "3a080fb5-a8cc-41ad-bea3-62f38384fb79",
"jobs_id": "878d99db-0a68-4414-a428-2d6ac050b4af",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "742a5a87-02b5-4410-b751-904ada88019a",
"_parent_id": "f97ce1af-227a-460d-8caa-2b76ff2479d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "47b4c967-c70c-4c21-8bf5-a39eabbab44a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4fe6c57e-d6bf-47b4-8eda-8b8218a74e78",
"_parent_id": "11245740-ce1c-42ef-b905-ecdf7367af41",
"root_parent_id": "7d8398e1-dc7e-4590-bcf5-d9209730beae",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "20fa9580-0113-4afe-8908-58e8acf92fb6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "136cd98c-ca95-43c2-be9d-c63faf531160",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b22beac9-088d-479f-a82d-ec4eff6b35fa",
"_parent_code": "sample string 6",
"sales_organization_id": "b429bf6c-755b-43d5-8eca-369e228b1410",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
},
"equipment_model_id": "82c36f7c-d8a8-45a9-b4ca-d4db4ff8f479",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6a7844fb-4453-4c51-93ee-b7bd173a13fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "537c50d3-349c-4ae9-af90-0ea36497dbf7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "db2515d1-d289-43c3-9d44-583b174b894c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2f5ac420-c911-43dd-8172-d76ba11c395d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
},
"equipment_family_id": "ba8f96e9-e30d-4c93-ac05-671910f9028b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "136cd98c-ca95-43c2-be9d-c63faf531160",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b22beac9-088d-479f-a82d-ec4eff6b35fa",
"_parent_code": "sample string 6",
"sales_organization_id": "b429bf6c-755b-43d5-8eca-369e228b1410",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
},
"date_in_production_since": "2025-10-22T18:45:45.6909801+00:00",
"date_out_of_production_since": "2025-10-22T18:45:45.6909801+00:00",
"date_end_support": "2025-10-22T18:45:45.6909801+00:00",
"sales_organization_id": "dfeb5a1b-fb64-4b10-af5d-8a47c8552263",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+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": "2025-10-22T18:45:45.6909801+00:00"
},
"project_status_id": "80076f0b-1c7f-43a2-8083-8b2e17bb8d17",
"project_status_code": "sample string 10",
"project_status": {
"id": "7598d895-d291-41d7-b6d8-1a21f2bbe200",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "15527b1c-550c-44f5-aeaf-cd00ef1ed690",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
},
"company_id": "8aebf8a8-018f-4ee4-b63f-9d1cd11f752b",
"company_code": "sample string 12",
"db_address_id": "66941046-5ef2-4eb1-a6da-af2ff9cb5387",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fd0eba55-26fc-4c4c-a9a2-30140c33d573",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c2c49ab2-4db5-48a2-a10d-8b3bb21185dd",
"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": "2025-10-22T18:45:45.6909801+00:00",
"date_create": "2025-10-22T18:45:45.6909801+00:00",
"date_update": "2025-10-22T18:45:45.6909801+00:00",
"updated_by_user_id": "0218fae6-fa37-4a80-83ab-942b5256c88e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-22T18:45:45.6909801+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": "2025-10-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-22T18:45:45.6909801+00:00",
"date_last_job": "2025-10-22T18:45:45.6909801+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-22T18:45:45.6909801+00:00",
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00",
"is_mobile_installation": true
},
"job_type_id": "c3e50fc8-7de5-4608-9e9d-e2a0338f236b",
"job_type_code": "sample string 7",
"job_type": {
"id": "096463b5-7a9e-4a96-9045-b5590fa9376e",
"name": "sample string 2",
"sales_organization_id": "736f81e8-66c6-4314-a000-80240b798805",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00",
"code": "sample string 7"
},
"job_priority_id": "11d9b934-6d61-41bd-a2d0-1a6fe88c844b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4b695528-66a5-41d6-91ee-e7b8633d576d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "68e7e07c-2a3c-493c-9a44-7fd6ea5d2891",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
},
"job_status_id": "3fb68b12-b753-45e3-955e-b038926aa1b8",
"job_status_code": "sample string 11",
"db_address_id": "3a869f43-ce99-4e6f-889c-42650acfc5a0",
"contact_id": "a9b89a51-1e24-48ce-947a-08d2a11a8cb6",
"requested_by_company_id": "f4947a14-5b8e-4483-99b9-75c6d2a480a9",
"requested_by_contact_id": "b00652ee-6726-41f4-b544-676ec03cfa16",
"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": "2025-10-22T18:45:45.6909801+00:00",
"due_date": "2025-10-22T18:45:45.6909801+00:00",
"date_create": "2025-10-22T18:45:45.6909801+00:00",
"date_update": "2025-10-22T18:45:45.6909801+00:00",
"date_closed": "2025-10-22T18:45:45.6909801+00:00",
"suggested_user_id": "7447c081-35f0-4152-ad8c-c0b795525153",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "53874047-a8da-49d1-9e38-94add504835c",
"db_language_id": "9d07e72b-ac0f-4e4c-950f-ced8405ccff8",
"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": "2025-10-22T18:45:45.6909801+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f19e0044-9352-4e95-b28a-573ea6f1ac30",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c078b312-719f-4be4-ae69-3b45418b9895",
"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": "4cf32701-3407-4d34-a484-951e65efa498",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "901ef366-e5df-461b-9cbb-08b79b95db0b"
},
"suggested_date_start": "2025-10-22T18:45:45.6909801+00:00",
"skill_id": "40ebb07a-63d2-4b52-b075-913746085a5b",
"skill_code": "sample string 32",
"skill": {
"id": "a6fb4d00-3ed1-486d-8e15-8260cb7bd8c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8e73de12-0cfe-4f14-8458-5cc5b2b07886",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3e04972c-25a9-4b45-a01d-5e1f320c91cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d080d7a-f057-42b0-aa48-93adc96b041b",
"db_currency_id": "63dd12b3-87e4-413f-b27d-c675397b81c0",
"db_language_id": "95218400-91c8-4805-833b-0e0d2a96f743",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8efabd44-f1d3-4dfa-8b58-1a793eb18ff9",
"date_reported_by_company": "2025-10-22T18:45:45.6909801+00:00",
"id2": 36,
"company_id": "67654ce7-2bf7-4025-a1c4-6eb86351a64a",
"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": "f897336e-3a2c-4aa7-ae1e-fb77575b152e",
"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": "2025-10-22T18:45:45.6909801+00:00"
},
"work_instruction_details_id": "fa88c321-f59b-4f17-92dc-1937d3e96e9d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5c986a77-d988-4f52-a5a8-c23e9abb5ec4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c9a1cec5-7522-46b6-a0e0-d0891cd6fb03",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-22T18:45:45.6909801+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": "6234c717-1435-4bec-ae92-f0a62ca01772",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-22T18:45:45.6909801+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.