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": "5f647c60-427e-49ef-899d-f8f99161629d",
"jobs_id": "abf5a728-fc99-49e1-90fa-d4f835abc5d5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d5caf051-3e48-4a1e-97bf-dccde7f2d83f",
"_parent_id": "4abee9f8-bf42-4ce5-8241-e0150c1fd512",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "390d6f51-9c96-4928-8a93-023bd8324a95",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6a4a9385-1c68-4961-a483-8766c9a0b41c",
"_parent_id": "d26686c9-e73f-484c-8e62-61843b718f11",
"root_parent_id": "2ef25063-8f21-4b8b-a3c8-ad81732fa8be",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "60c363a2-a6bf-40ad-9987-d4a41f40fa86",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8107d3c8-5d88-4bce-aa76-b31668d2ca07",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f9427632-27c2-40da-82f8-764a8ca2ab9f",
"_parent_code": "sample string 6",
"sales_organization_id": "61f07781-117c-45e7-ad99-1510e7f9de6f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00"
},
"equipment_model_id": "4776a419-3f8b-4a7f-aac6-f53034ffcbd9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b88cd9f5-d6d2-4ae0-b9bd-a7c64a6705a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2a725bac-d180-44e8-8c51-e872b4c8101a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "264623b1-1fa4-4bc2-9217-e65948c33995",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c62efda1-d815-4483-94fb-587f3928e4f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00"
},
"equipment_family_id": "60e63a1f-f1b8-4b2e-9aa9-4faf9fdcb5e4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8107d3c8-5d88-4bce-aa76-b31668d2ca07",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f9427632-27c2-40da-82f8-764a8ca2ab9f",
"_parent_code": "sample string 6",
"sales_organization_id": "61f07781-117c-45e7-ad99-1510e7f9de6f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00"
},
"date_in_production_since": "2026-04-08T22:22:37.1379463+00:00",
"date_out_of_production_since": "2026-04-08T22:22:37.1379463+00:00",
"date_end_support": "2026-04-08T22:22:37.1379463+00:00",
"sales_organization_id": "6eabc2f0-aba8-49aa-b1ef-f7cd852f3890",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+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-04-08T22:22:37.1379463+00:00"
},
"project_status_id": "122dee5a-b361-4997-a850-5b4e19c3db70",
"project_status_code": "sample string 10",
"project_status": {
"id": "60d5344c-411e-405d-a6fd-b3f00f44769e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a75f937b-6804-4267-939c-f3bd1b68acfe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00"
},
"company_id": "2368cc27-bcd3-4299-872e-0a8e9daec553",
"company_code": "sample string 12",
"db_address_id": "279b19bf-4980-4228-a002-1a86092da654",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2a64697c-28e6-482a-a892-b3473031ac65",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "32fb7152-f41f-4d5b-a170-8ff54be730b4",
"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-04-08T22:22:37.1379463+00:00",
"date_create": "2026-04-08T22:22:37.1379463+00:00",
"date_update": "2026-04-08T22:22:37.1379463+00:00",
"updated_by_user_id": "0ab0f30f-a7ff-4c92-b338-721c4d42ad79",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-08T22:22:37.1379463+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-04-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-08T22:22:37.1379463+00:00",
"date_last_job": "2026-04-08T22:22:37.1379463+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-08T22:22:37.1379463+00:00",
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00",
"is_mobile_installation": true
},
"job_type_id": "50fdf3d7-6f83-4ca8-a69c-961bdb57471f",
"job_type_code": "sample string 7",
"job_type": {
"id": "158fa7f1-7d1a-4db7-96f9-e0680c09bee6",
"name": "sample string 2",
"sales_organization_id": "6712a4e5-e3df-4477-9767-f9d04f80cae1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00",
"code": "sample string 7"
},
"job_priority_id": "fadd978c-99c4-4cb1-af99-c00b3bb5ae57",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eba7746c-7cb6-43bd-aa89-6771791be70a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7f33cc84-a244-437b-8ee7-1555b9f60c24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00"
},
"job_status_id": "d0e27b67-c843-41fd-bb90-334526ee74f1",
"job_status_code": "sample string 11",
"db_address_id": "7b87ce80-52cd-4cd3-8b32-db877aa17e1b",
"contact_id": "f1561e9e-981b-4df2-aeca-431394d7ad2c",
"requested_by_company_id": "79dcd9e2-09ad-46bc-8369-7e0e3c5f9cfd",
"requested_by_contact_id": "0fb58905-bda6-4c1d-809e-68b9b63368fa",
"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-04-08T22:22:37.1379463+00:00",
"due_date": "2026-04-08T22:22:37.1379463+00:00",
"date_create": "2026-04-08T22:22:37.1379463+00:00",
"date_update": "2026-04-08T22:22:37.1379463+00:00",
"date_closed": "2026-04-08T22:22:37.1379463+00:00",
"suggested_user_id": "3c5c56a7-aeef-48d0-a3bf-3b4d353faaf5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b570dded-390d-4da5-8074-774fc603a95c",
"db_language_id": "2cd15f64-bac3-4286-8554-395b120aa7f9",
"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-04-08T22:22:37.1379463+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2acdf385-5dc9-4472-931d-79016e6e1d5a",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1a76cb20-958b-4915-8c05-441b7a2d0169",
"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": "763f02e1-ba01-45d8-a658-b6a15fa5a4ac",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e8e021cf-a369-4e6b-936a-412cfa2f279e"
},
"suggested_date_start": "2026-04-08T22:22:37.1379463+00:00",
"skill_id": "754dfcad-1ff9-41f1-80d1-2541bcbb5bc4",
"skill_code": "sample string 32",
"skill": {
"id": "79290de4-de14-43df-bd1f-36bb82a4f1b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d7fd44df-7657-434f-b3dc-393bf08dc70b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3392984b-c66a-41af-b17f-0b84f4f07c03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7620fb5e-7b1c-4309-b236-f6ef2b586d0d",
"db_currency_id": "e17b2439-d078-4e45-a8e1-cdb7e16b9731",
"db_language_id": "5c200d2f-1b66-4cc1-a095-5c50bc864fcc",
"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-04-08T22:22:37.1379463+00:00"
},
"modified_dateutc": "2026-04-08T22:22:37.1379463+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "781d660e-b455-4374-adea-892232698933",
"date_reported_by_company": "2026-04-08T22:22:37.1379463+00:00",
"id2": 36,
"company_id": "09497507-7d0f-4a67-938b-c3837d2b878e",
"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": "61c06f0d-25fd-4343-8d72-637b8bb01fa9",
"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-04-08T22:22:37.1379463+00:00"
},
"work_instruction_details_id": "508b2f65-1e5a-4493-ae9c-0df5b98e519c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "560fcc64-4362-4732-b87b-bdb4d5bff133",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fa075fb1-5eea-441d-90d8-32ecc674e98f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-08T22:22:37.1379463+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": "752acf72-306e-4777-b7b0-a4f3528138f1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-08T22:22:37.1535693+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.