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": "58d867c9-b68e-44b3-99cd-f68286e2caee",
"jobs_id": "510e5bf9-a60a-448b-876a-26be524d403c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c696845e-cdbd-4faa-9a11-8f809ee7e908",
"_parent_id": "34dcd9da-bdf9-4c74-9330-37f343544983",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c568521e-43d9-44c9-99e3-1227f762c543",
"project_reference_back_office": "sample string 5",
"project": {
"id": "54505f34-2e43-482b-99ab-a3bd895c67d6",
"_parent_id": "6aeb6cef-ea50-4a24-8911-15704c1caf91",
"root_parent_id": "4e8bf836-12c7-4e8a-97cf-a30d2dc83a67",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6016b969-4645-4a9a-9f1b-76fb0abb8fd4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "441b0575-51b1-4baa-b5cf-e5bec3ba11fc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "48d934a0-4ab0-4ae5-b0a8-769364c179ea",
"_parent_code": "sample string 6",
"sales_organization_id": "7e976ae9-aed8-479d-b6df-4213db77a412",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00"
},
"equipment_model_id": "a21a97cd-ec66-450a-8cca-f58e9435c13d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "399c4630-1492-41ec-9791-bb70f85e46bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f986aaaf-60d5-4341-aac9-ca7db96c272d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b0aff8f9-f86d-41ec-858f-a18a01883408",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "80561ee0-6ed8-4e23-b816-669054001b86",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00"
},
"equipment_family_id": "a89574f8-230d-47a7-8062-0534a91d5907",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "441b0575-51b1-4baa-b5cf-e5bec3ba11fc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "48d934a0-4ab0-4ae5-b0a8-769364c179ea",
"_parent_code": "sample string 6",
"sales_organization_id": "7e976ae9-aed8-479d-b6df-4213db77a412",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00"
},
"date_in_production_since": "2026-07-11T21:16:39.0459241+00:00",
"date_out_of_production_since": "2026-07-11T21:16:39.0459241+00:00",
"date_end_support": "2026-07-11T21:16:39.0459241+00:00",
"sales_organization_id": "07cfb380-7200-4094-80e2-89e44398703e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+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-07-11T21:16:39.0459241+00:00"
},
"project_status_id": "ef08f978-c757-4ca8-8cd4-5778a1debe6c",
"project_status_code": "sample string 10",
"project_status": {
"id": "76fe240d-91f3-4f03-bab3-04f0c3f4fb90",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f730d44d-1674-43c7-838f-1e28b03e516a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00"
},
"company_id": "f4ec17fd-d147-4df2-b671-6aa040525b4a",
"company_code": "sample string 12",
"db_address_id": "a4e15489-4a81-4839-a857-391986f8804f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9f1d4e54-b077-45a6-adad-07eafc5cf29c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6f4e8187-2a24-4919-a5bf-6a7c72b25b48",
"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-07-11T21:16:39.0459241+00:00",
"date_create": "2026-07-11T21:16:39.0459241+00:00",
"date_update": "2026-07-11T21:16:39.0459241+00:00",
"updated_by_user_id": "f29a8f7e-19b1-4f86-839b-1b2fd046b699",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T21:16:39.0459241+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-07-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T21:16:39.0459241+00:00",
"date_last_job": "2026-07-11T21:16:39.0459241+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T21:16:39.0459241+00:00",
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00",
"is_mobile_installation": true
},
"job_type_id": "94937118-7d14-4ce8-b38a-7461391a6448",
"job_type_code": "sample string 7",
"job_type": {
"id": "3287e97e-9555-4020-bcbf-549a26c8fda7",
"name": "sample string 2",
"sales_organization_id": "7e905eca-4411-4aaa-8090-864f7fafb1db",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00",
"code": "sample string 7"
},
"job_priority_id": "7f101a72-a409-4e21-b378-3b9c803cbc53",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "11691c49-928a-4292-93ba-d83ff6c8e01e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6e1c87f7-6c87-4863-9352-af8130bbdb8d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T21:16:39.0459241+00:00"
},
"job_status_id": "a7a38bf5-7ad9-4ac6-a4f1-f89988da5bc1",
"job_status_code": "sample string 11",
"db_address_id": "4ea45705-84bf-4d0b-8aff-402dc07538c0",
"contact_id": "93a8c389-f137-4374-8541-8462e3bf58bc",
"requested_by_company_id": "173a6b19-e83f-4112-8608-69a1f3e67658",
"requested_by_contact_id": "f1daab23-a61e-4225-bc64-cfef1cf1f030",
"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-07-11T21:16:39.0459241+00:00",
"due_date": "2026-07-11T21:16:39.0459241+00:00",
"date_create": "2026-07-11T21:16:39.0459241+00:00",
"date_update": "2026-07-11T21:16:39.0615438+00:00",
"date_closed": "2026-07-11T21:16:39.0615438+00:00",
"suggested_user_id": "d3e6e7c0-6a18-4234-83bc-a709fbf7d3ae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "699d6a84-57e8-43a7-80ee-01f2868ce15d",
"db_language_id": "a27209df-dad0-4366-9da4-db0b95ccd478",
"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-07-11T21:16:39.0615438+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01f9200f-9215-4da3-aa29-b3415551e642",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7140037b-099d-4068-8f5c-008a815deefb",
"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": "8e6cd0eb-93aa-4d66-a436-454b57516002",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T21:16:39.0615438+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "24a1a135-b38d-45d1-b5bd-7bb02400bc1e"
},
"suggested_date_start": "2026-07-11T21:16:39.0615438+00:00",
"skill_id": "adfca6e3-498d-4bed-ab02-a9855e201c6f",
"skill_code": "sample string 32",
"skill": {
"id": "1d83a2e9-3e17-44cd-b521-c4e352a67596",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0884cd83-ed89-45a6-840c-9b8c860879ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b869bb0c-594b-49c5-b673-66ccc99822b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c3e622-d292-4df7-b42b-1581def62890",
"db_currency_id": "4a0a55bd-2761-4f29-8eef-816d3054badb",
"db_language_id": "f858495e-d7ea-451c-905c-f26943389b10",
"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-07-11T21:16:39.0459241+00:00"
},
"modified_dateutc": "2026-07-11T21:16:39.0615438+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ef2c70bd-0ef7-44b8-a268-a8f66e298b46",
"date_reported_by_company": "2026-07-11T21:16:39.0615438+00:00",
"id2": 36,
"company_id": "89903746-0021-4bfd-9855-f4dd39189e7e",
"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": "744ad2be-76f5-4fd0-90c4-ff700cfe0bfe",
"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-07-11T21:16:39.0615438+00:00"
},
"work_instruction_details_id": "10cacf97-5128-48b3-9499-9f2c0d50b9b2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cdb26778-1998-4bd9-a595-b0336ca10760",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4cd67d1c-1578-4da6-873a-828edb12372e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T21:16:39.0615438+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": "7f724460-ba71-4b9d-b15c-47c7117b258e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T21:16:39.0615438+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.