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": "fc736624-713e-482a-8289-2f5b2cce055d",
"jobs_id": "1a9b2512-e097-4c9d-b185-02addcc6d429",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db04f7dc-127a-4edf-9d2f-ca8607421736",
"_parent_id": "40c32f8e-0a51-4083-844d-9f395c4505e9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84797e41-1c11-48f3-b389-fd80df2d23bb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f30e7403-f43f-4fd3-a1b9-5c657965a721",
"_parent_id": "d09859ea-c0e7-42ac-800c-fa21f1deaf28",
"root_parent_id": "d275453e-3bc9-4b56-ba1c-1d44bcb247fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cce7f3e5-0adf-4667-b373-48f6a17b3fe4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b2c96e3e-a7c2-49e4-9890-abdbfe857603",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da5b6afc-dc84-439b-88d6-0062e34d3cf7",
"_parent_code": "sample string 6",
"sales_organization_id": "c57ed680-cf17-4196-8ca6-275d2fbb4ad5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00"
},
"equipment_model_id": "2dd0d747-47db-454a-b7cf-aef23bb96371",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64924f4e-d2a7-4cd6-9dca-2bacc2dc416e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7cce0a65-0232-4a95-9a4a-5c7a45888260",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a6774ba8-f171-41b1-85c7-3ba0daf2ba87",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "97b089cd-a678-4714-8b24-058811728fb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00"
},
"equipment_family_id": "be20e3b8-dff4-42a9-b840-e499ea3a1bcc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b2c96e3e-a7c2-49e4-9890-abdbfe857603",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da5b6afc-dc84-439b-88d6-0062e34d3cf7",
"_parent_code": "sample string 6",
"sales_organization_id": "c57ed680-cf17-4196-8ca6-275d2fbb4ad5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00"
},
"date_in_production_since": "2025-09-15T22:28:19.8038157+00:00",
"date_out_of_production_since": "2025-09-15T22:28:19.8038157+00:00",
"date_end_support": "2025-09-15T22:28:19.8038157+00:00",
"sales_organization_id": "444e6d76-9ce2-45db-a0d3-3df3f2314463",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+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-09-15T22:28:19.8038157+00:00"
},
"project_status_id": "5169bed5-0d4c-4b6f-ad81-b05cc2618cfa",
"project_status_code": "sample string 10",
"project_status": {
"id": "2e4dd8cf-ce39-4999-a54f-5473cb23232e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5f15c579-03da-47d7-a5ac-0a4b3b240408",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00"
},
"company_id": "a61e5971-f47d-4b11-b2c9-302a7b0d8f63",
"company_code": "sample string 12",
"db_address_id": "f0a9b528-c898-4f35-952e-c18755961fa9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc6022ea-6b69-49bc-8816-dce813342254",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ef8c999a-28c0-4ad0-b303-0e2b1fe6b7f2",
"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-09-15T22:28:19.8038157+00:00",
"date_create": "2025-09-15T22:28:19.8038157+00:00",
"date_update": "2025-09-15T22:28:19.8038157+00:00",
"updated_by_user_id": "02b53e3a-9a0d-418c-8840-af393fcb01f7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-15T22:28:19.8038157+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-09-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-15T22:28:19.8038157+00:00",
"date_last_job": "2025-09-15T22:28:19.8038157+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-15T22:28:19.8038157+00:00",
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00",
"is_mobile_installation": true
},
"job_type_id": "e5ed245a-6d05-4591-b273-ecefd948a296",
"job_type_code": "sample string 7",
"job_type": {
"id": "d7095a4e-79d2-4a34-ae8b-6158a331088f",
"name": "sample string 2",
"sales_organization_id": "8cc9096e-7d16-42e3-a6f0-3673dc9db46e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00",
"code": "sample string 7"
},
"job_priority_id": "e955a9dc-8cd5-44a9-b377-39734c69f87c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "71fd7288-b8b4-408a-b402-81061448c85e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c43885ef-0c0b-40b3-88bb-661f3718d73f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00"
},
"job_status_id": "01b431c3-49fa-44ea-9dbe-8ed4873e10d7",
"job_status_code": "sample string 11",
"db_address_id": "b9b7e9e9-6aef-4931-b9ef-bfa614f406c8",
"contact_id": "92df8c6f-e52f-45c1-b53c-b2e642599789",
"requested_by_company_id": "74d85d71-764a-4583-910a-04f6042b163b",
"requested_by_contact_id": "84b6866c-24f1-471a-b6d0-728bb86527c2",
"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-09-15T22:28:19.8038157+00:00",
"due_date": "2025-09-15T22:28:19.8038157+00:00",
"date_create": "2025-09-15T22:28:19.8038157+00:00",
"date_update": "2025-09-15T22:28:19.8038157+00:00",
"date_closed": "2025-09-15T22:28:19.8038157+00:00",
"suggested_user_id": "2b9fa3b8-8c08-4a56-8c13-c829379c5c2e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5a446b33-886b-463a-afe7-91f7faa8a138",
"db_language_id": "060bf54f-b1aa-46ec-9c5f-4ad517113be6",
"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-09-15T22:28:19.8038157+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c6026819-239c-447a-96dd-0b8202ab7251",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f34b1145-7120-4c4d-b66e-28dfc8eaf8fb",
"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": "a321893d-866a-4d92-81c5-a16835749f7e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fe6419af-b557-474d-afae-c8c997a51017"
},
"suggested_date_start": "2025-09-15T22:28:19.8038157+00:00",
"skill_id": "0c522ce8-f009-4e41-b0e9-c66dd327f61d",
"skill_code": "sample string 32",
"skill": {
"id": "d21641cb-d42b-4afc-82d4-8b0df186f5ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0e68be1e-b41b-45cf-9bc8-a7545d7e227f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f81aa31c-4895-42ae-aa44-8a874633b331",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05367b7a-680c-4ea3-8e89-3eccc61b330b",
"db_currency_id": "f032d388-077d-4c91-90b4-be8c260504fa",
"db_language_id": "482900b3-5156-4079-8664-63b79cb6ec18",
"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-09-15T22:28:19.8038157+00:00"
},
"modified_dateutc": "2025-09-15T22:28:19.8038157+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2f69b0b2-457d-4289-b990-002190e8a101",
"date_reported_by_company": "2025-09-15T22:28:19.8038157+00:00",
"id2": 36,
"company_id": "981fe6de-a255-43e6-b12d-f42b12b52e74",
"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": "d56df583-6bf0-4343-939b-09df34ac9be9",
"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-09-15T22:28:19.8038157+00:00"
},
"work_instruction_details_id": "10f96504-f09a-4f28-967f-5baa00e5c942",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f974ca25-f608-4000-a114-5c760b8b3f1a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ff2cd9dd-805c-4ee6-94af-359706aa393d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-15T22:28:19.8194444+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": "3b71ab98-6eef-4ec7-a9c6-0607954c4096",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-15T22:28:19.8194444+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.