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": "4b72d90f-a84a-41b6-b7cc-36c6775ec0cd",
"jobs_id": "a14bd011-2080-46ab-875a-18cbe5eeb04f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "00963989-3611-4870-834b-78c5fa876c70",
"_parent_id": "ecd19039-b8cd-44a4-a85d-2371d7ca9fd2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0d199b76-22a7-4ce8-9d7e-6347a522821c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dfdd214f-7d32-496f-ade2-32c4f74674da",
"_parent_id": "5ab5f9f8-3f51-4711-a6f2-f7fcf528dc6c",
"root_parent_id": "cb84474f-ab6e-4e24-b9ac-fbb5b9a42f03",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d06a7616-61ed-49aa-94d5-f4fdaa8285d7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "44af9e33-5b7e-4486-9e79-db591abc92e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a320eac6-feaa-4ba0-ae74-4c757ade1ee2",
"_parent_code": "sample string 6",
"sales_organization_id": "a23d7ac9-fa57-4bf1-9b76-7c71364dd132",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"modified_dateutc": "2025-12-28T08:57:07.8291431+00:00"
},
"equipment_model_id": "3e453ad4-2959-44d3-b3a4-17f322e07a2c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "708ee925-9606-44e7-b578-a5c98fcd1bae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eae65692-b554-487a-a035-f372d4d78ee7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "49a132f5-ca9e-47b0-91fd-7359542d565a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c658f0e0-d947-47b8-b834-ca9781081386",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"modified_dateutc": "2025-12-28T08:57:07.8291431+00:00"
},
"equipment_family_id": "6a68c05f-5968-4aac-9eac-f4c93babf646",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "44af9e33-5b7e-4486-9e79-db591abc92e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a320eac6-feaa-4ba0-ae74-4c757ade1ee2",
"_parent_code": "sample string 6",
"sales_organization_id": "a23d7ac9-fa57-4bf1-9b76-7c71364dd132",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"modified_dateutc": "2025-12-28T08:57:07.8291431+00:00"
},
"date_in_production_since": "2025-12-28T08:57:07.8291431+00:00",
"date_out_of_production_since": "2025-12-28T08:57:07.8291431+00:00",
"date_end_support": "2025-12-28T08:57:07.8291431+00:00",
"sales_organization_id": "a536abb0-9720-4148-bd6b-111a73dbce9c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+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-12-28T08:57:07.8447689+00:00"
},
"project_status_id": "8fb9b654-73d2-4ed0-80ff-9f1d226f6ed1",
"project_status_code": "sample string 10",
"project_status": {
"id": "f64792c9-50c9-4440-8184-98a2deb5c8f8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "55e3ff4f-5033-4a8e-a8ad-ad118feec589",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00"
},
"company_id": "20b32db1-5150-4946-a0fd-0bd5d06d9f7e",
"company_code": "sample string 12",
"db_address_id": "f850eef8-42df-45db-9eca-e4acd6ddbab4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9218085b-cc1d-4017-828c-19ff10e4abe0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a4d00b40-603c-4606-8a0f-dc38bee252c3",
"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-12-28T08:57:07.8447689+00:00",
"date_create": "2025-12-28T08:57:07.8447689+00:00",
"date_update": "2025-12-28T08:57:07.8447689+00:00",
"updated_by_user_id": "25a102d2-6cc8-4ef9-b2f5-ba79b4fcce9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-28T08:57:07.8447689+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-12-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-28T08:57:07.8447689+00:00",
"date_last_job": "2025-12-28T08:57:07.8447689+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-28T08:57:07.8447689+00:00",
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00",
"is_mobile_installation": true
},
"job_type_id": "c614a9c6-0747-4f51-b9bc-b7d8505fc110",
"job_type_code": "sample string 7",
"job_type": {
"id": "5c3230ab-a056-4d62-af54-ec8f8042a1ad",
"name": "sample string 2",
"sales_organization_id": "d5d7d7b6-789b-4618-a2cd-e123daa215eb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00",
"code": "sample string 7"
},
"job_priority_id": "918f5a10-7f85-48ff-8749-583976e3e32e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "792aa8ef-41f8-48bd-80ac-e3490960c07a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "db65dc64-7843-40de-92d0-22a982e28b93",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00"
},
"job_status_id": "40d2c385-6bec-4fdc-b63e-50fc0e6858dc",
"job_status_code": "sample string 11",
"db_address_id": "75da1e82-555b-464e-bb66-126461acb9f3",
"contact_id": "82f5952a-72f5-4f69-83d3-08ef379d1a3f",
"requested_by_company_id": "760a2acb-2878-4abc-adc3-2debc67e3f0d",
"requested_by_contact_id": "e72ff92b-5a17-46c5-a064-15298e140aae",
"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-12-28T08:57:07.8447689+00:00",
"due_date": "2025-12-28T08:57:07.8447689+00:00",
"date_create": "2025-12-28T08:57:07.8447689+00:00",
"date_update": "2025-12-28T08:57:07.8447689+00:00",
"date_closed": "2025-12-28T08:57:07.8447689+00:00",
"suggested_user_id": "cbd937ca-d845-4e9f-af1e-b8975fc87bbe",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "26db3343-d174-423f-b78b-fa749385347d",
"db_language_id": "d13fe6a1-eafb-4d5b-94ef-f5d9dc3d9a22",
"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-12-28T08:57:07.8447689+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "44963656-5236-458d-b916-43e30d922c65",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9b117388-aee1-40df-8932-bdf1ddb573f2",
"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": "9d14499e-7498-45ac-8362-a086d338a763",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "961aeb53-44c6-4cf6-801b-e5e0112d9312"
},
"suggested_date_start": "2025-12-28T08:57:07.8447689+00:00",
"skill_id": "3c3de079-2f5d-437e-9024-cdb449a0d1d9",
"skill_code": "sample string 32",
"skill": {
"id": "eb17cc2a-63c1-4e44-bb3e-4e3b60c4bc33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3c9f3392-2a0d-4d51-bb87-a67dac9bd987",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a795ec-dae7-457c-9d2a-2df89b1efbe6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44a08c2c-71cb-4280-a765-fcb824117980",
"db_currency_id": "63489f00-99b0-44e4-95d8-3bf378190b33",
"db_language_id": "b0ecb7cb-6c82-4e69-aec3-9511341c31d4",
"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-12-28T08:57:07.8291431+00:00"
},
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ea79d8e0-6740-4f70-a6d4-850b8209ada3",
"date_reported_by_company": "2025-12-28T08:57:07.8447689+00:00",
"id2": 36,
"company_id": "579c54bf-9042-4f97-a01f-66500359de99",
"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": "7a73f279-2073-4a04-ae79-e45da903b589",
"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-12-28T08:57:07.8447689+00:00"
},
"work_instruction_details_id": "f8de63c6-e86b-4ce3-9ed0-a6e0547ded76",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95aca37b-99c5-4254-937b-2629d14ee75a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "09e8d851-0dc4-47a5-bbbb-5963bece820d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-28T08:57:07.8447689+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": "455fa924-82c0-46f5-a0cc-137b6fc439ab",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-28T08:57:07.8447689+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.