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": "f785f104-2a26-461b-9466-1a4c3ebce2aa",
"jobs_id": "acd5828f-0825-48aa-a7ca-1e94861f6489",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8c36457a-442b-4e3d-8593-eb40a65932e4",
"_parent_id": "b5265bab-9bf2-4ba5-ba6c-c32ea9c56aca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bceca8db-77db-4f82-a6d1-8723556339fb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fb17c486-98ec-4bb4-85db-c8968bbd684c",
"_parent_id": "b5680270-a994-4f80-9390-6fc7aee33307",
"root_parent_id": "c29163db-e9b1-4577-9e21-6115de8e225f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6d91e9d4-9fde-4e4a-8830-c1e3bd788496",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ae988835-ca65-4030-91d8-934c2ceeb39c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3de2a3a8-cd85-4a31-928f-894f4636acd6",
"_parent_code": "sample string 6",
"sales_organization_id": "124f8425-a5c4-4016-a5e5-619c2dfec4c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
},
"equipment_model_id": "f9d8a25f-f615-4b41-a508-b5d719dd67e5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1314fe76-7b28-4fab-8171-967e76549dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "26125b55-15b7-4b81-8beb-ef054a1a6f14",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "951ffd94-08de-43db-9195-baf9f3046490",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7835754d-7575-40f6-b723-0ff52c2fdc92",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
},
"equipment_family_id": "9d44c8ba-0224-4069-a820-ea96e279582d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ae988835-ca65-4030-91d8-934c2ceeb39c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3de2a3a8-cd85-4a31-928f-894f4636acd6",
"_parent_code": "sample string 6",
"sales_organization_id": "124f8425-a5c4-4016-a5e5-619c2dfec4c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
},
"date_in_production_since": "2026-05-30T13:54:33.1589946+00:00",
"date_out_of_production_since": "2026-05-30T13:54:33.1589946+00:00",
"date_end_support": "2026-05-30T13:54:33.1589946+00:00",
"sales_organization_id": "64d07bc9-f230-4c7f-aa4e-599f4473a3c4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+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-30T13:54:33.1589946+00:00"
},
"project_status_id": "76f31096-b1ea-4373-b68c-e4bb273240b2",
"project_status_code": "sample string 10",
"project_status": {
"id": "c936b8dd-5224-4d4e-acd3-b50141579195",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4b91ae85-8048-493c-8b01-d878b88eb1b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
},
"company_id": "0927b6dd-0c3e-457e-98ca-fac48f0f0bf4",
"company_code": "sample string 12",
"db_address_id": "f517d610-f3f8-45c3-ba28-66631791a8b8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "16a01c68-cb69-4174-b37d-086ce83acc20",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6e303d66-b321-44f2-b11c-e3162fb699bd",
"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-30T13:54:33.1589946+00:00",
"date_create": "2026-05-30T13:54:33.1589946+00:00",
"date_update": "2026-05-30T13:54:33.1589946+00:00",
"updated_by_user_id": "ac53b3ab-9d47-4c69-88b7-ac962f3afb0c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T13:54:33.1589946+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T13:54:33.1589946+00:00",
"date_last_job": "2026-05-30T13:54:33.1589946+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T13:54:33.1589946+00:00",
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00",
"is_mobile_installation": true
},
"job_type_id": "cc15ec61-0481-4a28-b9e9-95b8ad69663a",
"job_type_code": "sample string 7",
"job_type": {
"id": "f93c4957-475c-4a41-a195-4f953bc1e73b",
"name": "sample string 2",
"sales_organization_id": "61585895-ca2e-435c-b172-a5021a12ee36",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00",
"code": "sample string 7"
},
"job_priority_id": "45df24b0-62fd-4199-8653-aa35665c5693",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1f1795c4-0a15-4e1f-9d81-7b4a504acfed",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5bf2aa06-6cb3-4667-a5d1-ffff0addb322",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
},
"job_status_id": "692bddb6-51e3-44c1-9acf-f507234cda11",
"job_status_code": "sample string 11",
"db_address_id": "be4b0fd3-42a1-4065-b686-8052e1b5c60c",
"contact_id": "dd245bae-6931-46c2-98fd-4d3ebf20f17b",
"requested_by_company_id": "ead8e8ff-b710-45d0-8b2d-8bfeb9a15c3e",
"requested_by_contact_id": "e2ad82ce-667f-46ee-829e-610801d053f9",
"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-30T13:54:33.1589946+00:00",
"due_date": "2026-05-30T13:54:33.1589946+00:00",
"date_create": "2026-05-30T13:54:33.1589946+00:00",
"date_update": "2026-05-30T13:54:33.1589946+00:00",
"date_closed": "2026-05-30T13:54:33.1589946+00:00",
"suggested_user_id": "b07534f1-c7b6-4b46-b809-5a5a051acc89",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c7f42777-c576-4f14-9865-a9baf3fe7f50",
"db_language_id": "4c923f82-0221-412b-81ca-31064d8840dd",
"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-30T13:54:33.1589946+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6b3df381-d6e5-453c-8634-795b07f94b0d",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea5eda8a-21be-48c7-b6ff-dff3f5a27941",
"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": "341315de-44fb-46c0-8d22-483867bbb08e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9be269c7-6811-4d94-8f2f-a1d477fa7bfe"
},
"suggested_date_start": "2026-05-30T13:54:33.1589946+00:00",
"skill_id": "ba109769-adf6-47b7-95ff-3253de0de4ca",
"skill_code": "sample string 32",
"skill": {
"id": "e6ebdf86-aef4-4c2c-859e-6b7fae67a86c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33e37a95-9869-4c3e-a811-b95753d34f7a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7610f9bd-5443-4352-a8ab-46aa2be22783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd3556a4-9cec-45af-a3de-69371f78e79b",
"db_currency_id": "8b276d47-7d1b-4eb9-99d7-0be7232baae2",
"db_language_id": "0c3cfaf1-e5e4-45ec-9bc0-0f2187ba0d5a",
"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-30T13:54:33.1589946+00:00"
},
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0fdc5012-757a-43f8-b2c9-bd40e1b7dac8",
"date_reported_by_company": "2026-05-30T13:54:33.1589946+00:00",
"id2": 36,
"company_id": "97c1e61f-7b45-4d8a-954f-701b91b34aac",
"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": "f70ebd26-cefe-4bfc-81fc-0c57fcd1773d",
"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-30T13:54:33.1589946+00:00"
},
"work_instruction_details_id": "9e443e03-857f-4e89-a79d-81bf76671df3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4bb86fc2-e508-46ea-9e05-363b499de1e1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ccd5fa64-ab57-4366-b190-fddbdf185499",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T13:54:33.1589946+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": "080048a8-82c1-49ce-9b92-f343ce9f8e8e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T13:54:33.1589946+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.