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": "ebc5c814-9069-4f05-9cb4-9f2f34c252d9",
"jobs_id": "27213251-e1e2-438a-9e75-0e412850404f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b141fb7a-b100-45e6-836a-9abcbb79a516",
"_parent_id": "e7c3e6f4-6a95-48ae-82c3-f0724bbd023f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f2a53431-5e8e-4666-bfd0-87d308acafe9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c94ffd17-5802-4297-b497-186a5f62a17f",
"_parent_id": "4c4a1384-78aa-4b00-9ddf-c00049b6fdd5",
"root_parent_id": "1073053f-344c-4c68-bd1f-ff3e5c1e4469",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b9c383ec-bb56-4b4a-b49c-7e8963acfec1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dab91031-ff67-4ff8-8e36-5bdcc48d2159",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc77d242-6723-4a2f-8246-17621a9e671c",
"_parent_code": "sample string 6",
"sales_organization_id": "86b9775b-8fb5-49a4-b5ae-f08400135c26",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
},
"equipment_model_id": "2c1b0d34-d01d-4c22-818b-47e36b06aa92",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "71a2e798-2a23-42e8-aeea-d81e14dde028",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dace6682-23b2-469b-a825-fb7e5a6ce46d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "30644b74-da05-41e6-be27-6f6305457e5c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd13e280-5cc7-441d-b4cf-d801fc88add1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
},
"equipment_family_id": "f9d9e4e0-381c-4fee-8a9f-bf07d71754ae",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dab91031-ff67-4ff8-8e36-5bdcc48d2159",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc77d242-6723-4a2f-8246-17621a9e671c",
"_parent_code": "sample string 6",
"sales_organization_id": "86b9775b-8fb5-49a4-b5ae-f08400135c26",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
},
"date_in_production_since": "2025-12-05T16:43:04.8269963+00:00",
"date_out_of_production_since": "2025-12-05T16:43:04.8269963+00:00",
"date_end_support": "2025-12-05T16:43:04.8269963+00:00",
"sales_organization_id": "7ddb45e6-34b4-4eba-b7f8-cefa5926127f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+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-05T16:43:04.8269963+00:00"
},
"project_status_id": "a4e55127-fb9f-4a3c-9de3-a9e517a4be8c",
"project_status_code": "sample string 10",
"project_status": {
"id": "5b973571-d987-4d9c-8023-ff49d766049f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1afc89ab-5def-40cb-bdd8-c8a65b883620",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
},
"company_id": "9b9a65bb-b9b2-4b45-be4d-b32d1223483e",
"company_code": "sample string 12",
"db_address_id": "2a54d519-3497-4107-8085-99feb42dae95",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2993b16f-8a13-4e92-bb76-68f001f284ee",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d0fa1d48-3e26-4819-a476-bf14ebedb9ff",
"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-05T16:43:04.8269963+00:00",
"date_create": "2025-12-05T16:43:04.8269963+00:00",
"date_update": "2025-12-05T16:43:04.8269963+00:00",
"updated_by_user_id": "7faefefd-0b68-4149-8cdb-6cb513fe4d10",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T16:43:04.8269963+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T16:43:04.8269963+00:00",
"date_last_job": "2025-12-05T16:43:04.8269963+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T16:43:04.8269963+00:00",
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00",
"is_mobile_installation": true
},
"job_type_id": "6752d549-d402-49ce-b84a-b40952c16d97",
"job_type_code": "sample string 7",
"job_type": {
"id": "5efbdb52-2391-4b6e-a63d-17cca397a628",
"name": "sample string 2",
"sales_organization_id": "e0aed869-ab94-4e8a-8b2c-8459543322e9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00",
"code": "sample string 7"
},
"job_priority_id": "8db6058d-5dec-4605-a098-988b71b80235",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d5482f94-a402-4688-8ecc-c1cdbfc811a0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d0400ec4-2fa3-4052-9497-658155b45f3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
},
"job_status_id": "4375048f-4bbb-4410-96bb-da174772f2b2",
"job_status_code": "sample string 11",
"db_address_id": "3d9fc59f-81f1-43fd-af9c-18be6c527e4a",
"contact_id": "b04df30f-655c-49ae-9433-3b0b693659cc",
"requested_by_company_id": "afb29619-7eec-438a-8f48-212d0cb406b3",
"requested_by_contact_id": "5c93e837-71eb-4bb4-b4ac-d4f6b882a5e5",
"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-05T16:43:04.8269963+00:00",
"due_date": "2025-12-05T16:43:04.8269963+00:00",
"date_create": "2025-12-05T16:43:04.8269963+00:00",
"date_update": "2025-12-05T16:43:04.8269963+00:00",
"date_closed": "2025-12-05T16:43:04.8269963+00:00",
"suggested_user_id": "e8633984-2e6f-4337-b4ce-0095e6122f9d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "daea804a-8119-4012-a5f0-a1d4a866d6b5",
"db_language_id": "b064aa5b-2b78-487e-886d-243cb165a658",
"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-05T16:43:04.8269963+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e73da450-f8c3-4d63-bb92-93e9d07b6347",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8b892a6-ee50-4c83-a89a-0969ed4d15ab",
"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": "7b8e2a76-dff9-486d-b379-58c301465c73",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "afdcfd6d-9760-43d1-beab-85e41cc737e3"
},
"suggested_date_start": "2025-12-05T16:43:04.8269963+00:00",
"skill_id": "c722aac7-b964-4c26-9bcb-06df54ed34d3",
"skill_code": "sample string 32",
"skill": {
"id": "2cca2619-8eda-449f-8ae7-bb795b2bd227",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "74bb0065-214f-4f15-84b3-f4e3adf007b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f2149706-3a62-49ed-a84d-a0ce87041250",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b98f3d-e300-4673-95cf-c517f9a4c66b",
"db_currency_id": "032de8a1-30f7-453f-8f20-9b8e492fa184",
"db_language_id": "10257cd7-219f-4242-868c-55069db2ffd0",
"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-05T16:43:04.8269963+00:00"
},
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bb897fd0-07f3-4f3b-a81a-1cc167de3119",
"date_reported_by_company": "2025-12-05T16:43:04.8269963+00:00",
"id2": 36,
"company_id": "1d871465-0c90-4f72-9c7b-810d39a5dc2f",
"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": "c00f7db7-857d-4373-8829-83cbbd67ab74",
"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-05T16:43:04.8269963+00:00"
},
"work_instruction_details_id": "ea56fd47-f5ce-45dc-a872-1fa0bcf0bbec",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "39392443-fac3-4296-87c4-c451316f1002",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "360bacca-3188-499a-9e23-eb24734a0cb5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T16:43:04.8269963+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": "0bcb6ca6-ccbf-47c1-9bba-d7aa9af09e60",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T16:43:04.8269963+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.