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": "3c22e44f-6409-4578-a664-57ae9738d4de",
"jobs_id": "923346de-22f2-416d-8bce-74c7455a5a1e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "65ab56cb-81bf-4503-bc96-f05186e0f537",
"_parent_id": "cc1b21fd-1893-45c2-ad92-e4d5aba824a5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bc54a9b3-f8b8-4261-b153-1605846b237b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ecd11cf0-b788-4901-b7bc-06443e9bab37",
"_parent_id": "bba5775b-6752-471e-a5be-cfff2a5d1c84",
"root_parent_id": "8d77d163-e69e-4c0c-bb66-de6b14796c86",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "676da8d9-bb2c-48c8-a2a4-f1911a4f591f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "09e33074-1fb4-47f4-851d-2d381615c146",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eddcb639-1a2b-4bfc-bc0d-70b2ff603cea",
"_parent_code": "sample string 6",
"sales_organization_id": "ea13bab9-49c8-4a0c-9bf7-2a8f57933d5a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
},
"equipment_model_id": "e248f8f1-e9fb-4597-8e58-9d56d697b217",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0a245323-a79d-499c-8618-a0ea3413ae9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "abd4a1d1-3d0a-467b-95cd-484f0f90d022",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "52ee65b3-ce60-4208-a67f-382b00337032",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d3687622-b8ed-4cb7-9611-1e3991e946a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
},
"equipment_family_id": "b2ae5bb0-b2ef-480c-9740-da047196ed15",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "09e33074-1fb4-47f4-851d-2d381615c146",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eddcb639-1a2b-4bfc-bc0d-70b2ff603cea",
"_parent_code": "sample string 6",
"sales_organization_id": "ea13bab9-49c8-4a0c-9bf7-2a8f57933d5a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
},
"date_in_production_since": "2026-05-14T15:44:36.9382739+00:00",
"date_out_of_production_since": "2026-05-14T15:44:36.9382739+00:00",
"date_end_support": "2026-05-14T15:44:36.9382739+00:00",
"sales_organization_id": "de40cf29-b9de-4e49-aafa-7df0888193d0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+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-05-14T15:44:36.9382739+00:00"
},
"project_status_id": "c389ec24-00dd-4f86-8cec-0b506057aebb",
"project_status_code": "sample string 10",
"project_status": {
"id": "f65de546-1dbf-455a-9c49-69f95b30466c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "048a0e0e-766b-4159-a916-dfcf8d3d619c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
},
"company_id": "8ee9ca6f-bef5-4758-8cbc-ff6078c9ddd6",
"company_code": "sample string 12",
"db_address_id": "85129c77-4442-48bd-bdc7-7e0a249ede03",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "389abe9f-1fa5-4c86-947f-e96f2a8b5500",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d82e6be5-55bf-49c9-b774-c9df18a4d16d",
"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-05-14T15:44:36.9382739+00:00",
"date_create": "2026-05-14T15:44:36.9382739+00:00",
"date_update": "2026-05-14T15:44:36.9382739+00:00",
"updated_by_user_id": "f2ec8a7b-3b88-443d-8821-ae959a73e0ce",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-14T15:44:36.9382739+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-05-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-14T15:44:36.9382739+00:00",
"date_last_job": "2026-05-14T15:44:36.9382739+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-14T15:44:36.9382739+00:00",
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00",
"is_mobile_installation": true
},
"job_type_id": "c70eaff8-4a82-42b2-8e1c-d8617721f470",
"job_type_code": "sample string 7",
"job_type": {
"id": "caab0690-1c13-49d6-bd69-9ba29151ac01",
"name": "sample string 2",
"sales_organization_id": "b183dabd-f24b-46b4-86ee-145921a5737b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00",
"code": "sample string 7"
},
"job_priority_id": "926d284b-86ff-446b-a978-e3a169c53bfa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fca1cf58-c966-47ec-8ca6-1251426692cc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b5d7ad6f-4923-45f6-a7d0-31e40bcefbb1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
},
"job_status_id": "833246b1-e1e1-4b9a-88ad-f9402559c4d1",
"job_status_code": "sample string 11",
"db_address_id": "d0b75e08-eeb3-4b30-acd6-75ee11725f6e",
"contact_id": "4a4c309c-6f4c-414a-968e-27fa29c2bc64",
"requested_by_company_id": "7a88f544-91a9-486e-9cb4-0f84a59abf47",
"requested_by_contact_id": "8970eefb-75c1-4756-a51d-03bbc94a5ba8",
"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-05-14T15:44:36.9382739+00:00",
"due_date": "2026-05-14T15:44:36.9382739+00:00",
"date_create": "2026-05-14T15:44:36.9382739+00:00",
"date_update": "2026-05-14T15:44:36.9382739+00:00",
"date_closed": "2026-05-14T15:44:36.9382739+00:00",
"suggested_user_id": "78344097-72db-4ba4-9757-0d1904f8930e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0fd21509-b9b9-4650-b292-c3b3c7399384",
"db_language_id": "52bd3c44-370f-48a5-8345-fa436bbe5437",
"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-05-14T15:44:36.9382739+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2c60d604-f936-4942-96c0-3763269f10f6",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d7d1d54d-a08c-42b5-9b68-036e18de6e8c",
"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": "08ecda0b-ce08-4e30-bddd-5ac6bd5f120a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8688fc94-e67d-4bdd-a6a4-f49b20aa47df"
},
"suggested_date_start": "2026-05-14T15:44:36.9382739+00:00",
"skill_id": "4222e1ca-8ae5-481d-aaa0-65f642a2ba9e",
"skill_code": "sample string 32",
"skill": {
"id": "974f1b82-dd67-4289-8086-31c01d394970",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "27b109f7-81ef-4bc7-b76a-e12bf27481dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f46ec92f-a706-4934-883a-6270e7d68b60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "424e5d09-a84e-4822-8fde-f136c724388e",
"db_currency_id": "e3ae1b14-2636-42bc-bdab-d0882a421a3e",
"db_language_id": "b99edcb7-4725-4165-989b-c11932d1d3e5",
"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-05-14T15:44:36.9382739+00:00"
},
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8e8b9881-1fdd-4d69-ad01-bd71d16c6f1a",
"date_reported_by_company": "2026-05-14T15:44:36.9382739+00:00",
"id2": 36,
"company_id": "68683cf3-634d-4241-abc5-4c982311d0b6",
"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": "c4225816-a76d-46a7-8819-162aeadc11e1",
"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-05-14T15:44:36.9382739+00:00"
},
"work_instruction_details_id": "68450364-6848-47e5-9f44-29f520f1c1c3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d3c823a5-bba7-47de-9a1d-bd186751e33d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d5642345-7b33-441e-911a-1238523546d1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-14T15:44:36.9382739+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": "6cf044a6-4c07-4131-970f-67281cc84c9b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-14T15:44:36.9382739+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.