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": "bb66a04a-2490-47bd-a62a-969961840eeb",
"jobs_id": "082ac0f5-483b-4458-83da-65e49b462d0b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "701eb1fe-8941-4fea-bc8c-e60ac0acb1cd",
"_parent_id": "9c0ad4ee-1eb3-4dfd-91a2-c0f6a0d2b93f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fb04d154-b265-4ffa-b130-71d24de992a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "426b1320-40bf-4e38-947e-81c5ec46b60f",
"_parent_id": "ca673f18-fb4d-4a6d-b2d9-e69f3e266ad4",
"root_parent_id": "7c04cdae-f6e1-4df1-be73-6a1e39262e6e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cb7fbdbb-7011-4337-825f-f89853ca5f86",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "931bb987-5504-4312-96e3-5f156f8a344a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7244816b-b856-467d-a712-1878030db665",
"_parent_code": "sample string 6",
"sales_organization_id": "a23027d3-f7df-4dbc-8f5d-07ca33d2621c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
},
"equipment_model_id": "2ec26b0b-12bc-4353-b279-c8c00df3038b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d21d6b2b-a12c-42ee-9a9f-0a59b01afb42",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9b31d5fe-441c-4579-b334-32fe9ae6caca",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "23bca2f1-3814-4a0c-b1f4-5c6f9cc08f08",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a516a0c3-7b38-46eb-b334-8a9ac6bf3ec4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
},
"equipment_family_id": "ca3f65b7-9f59-474a-ade2-98cb6a866194",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "931bb987-5504-4312-96e3-5f156f8a344a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7244816b-b856-467d-a712-1878030db665",
"_parent_code": "sample string 6",
"sales_organization_id": "a23027d3-f7df-4dbc-8f5d-07ca33d2621c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
},
"date_in_production_since": "2026-06-02T03:50:10.2177214+00:00",
"date_out_of_production_since": "2026-06-02T03:50:10.2177214+00:00",
"date_end_support": "2026-06-02T03:50:10.2177214+00:00",
"sales_organization_id": "b21f7165-5119-4e04-8609-9ca80f9fde82",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+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-06-02T03:50:10.2177214+00:00"
},
"project_status_id": "69bd5bf3-43bb-4416-be72-2367bf1b1fe0",
"project_status_code": "sample string 10",
"project_status": {
"id": "42c3734f-0da4-451a-86b0-de67488e73f5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "242fd20e-4de9-4721-ab2f-c3b258078a6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
},
"company_id": "c2461eee-5c19-4cfd-9e7a-9fa6a176fd8c",
"company_code": "sample string 12",
"db_address_id": "db5531e8-88d1-4ed0-b0e7-38cd2158486a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "392021de-a4fd-4eb3-99f9-92a16fa9a4da",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c4e8ff1c-8791-4762-9837-16afb6413591",
"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-06-02T03:50:10.2177214+00:00",
"date_create": "2026-06-02T03:50:10.2177214+00:00",
"date_update": "2026-06-02T03:50:10.2177214+00:00",
"updated_by_user_id": "81df62ae-9739-44c1-a682-7245a4f7a07f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T03:50:10.2177214+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T03:50:10.2177214+00:00",
"date_last_job": "2026-06-02T03:50:10.2177214+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T03:50:10.2177214+00:00",
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00",
"is_mobile_installation": true
},
"job_type_id": "8e94c68a-4b4b-4970-82f3-6f486cb07958",
"job_type_code": "sample string 7",
"job_type": {
"id": "bea0439c-1b36-4393-b176-b14e0c20fc68",
"name": "sample string 2",
"sales_organization_id": "a71c3aaa-68a4-4f53-90d4-82cc34c5f67d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00",
"code": "sample string 7"
},
"job_priority_id": "bef0087f-85e8-40b4-bb70-f0896418e049",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e153ee24-198b-462c-bfca-8602edea8827",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3bc7c58c-69a1-4753-b0ab-197707195e82",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
},
"job_status_id": "1845a7ba-a713-4a9c-9dc1-e08d8989a5d4",
"job_status_code": "sample string 11",
"db_address_id": "8ea2102b-205e-439e-bb7b-d8b3858c53da",
"contact_id": "935c97ec-e2c7-483c-abc1-2952f187f705",
"requested_by_company_id": "f144465a-db32-411e-a2e7-9c682ea8e7ec",
"requested_by_contact_id": "eb6fc636-5213-49b7-890f-9af3f44c6b5b",
"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-06-02T03:50:10.2177214+00:00",
"due_date": "2026-06-02T03:50:10.2177214+00:00",
"date_create": "2026-06-02T03:50:10.2177214+00:00",
"date_update": "2026-06-02T03:50:10.2177214+00:00",
"date_closed": "2026-06-02T03:50:10.2177214+00:00",
"suggested_user_id": "639bb4b0-f1d1-4138-b3ee-ba5353417e62",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "98bad6d8-3231-4acd-9e66-e46525dbf20b",
"db_language_id": "b52aebdb-7d88-4f9d-ba56-f5163654630a",
"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-06-02T03:50:10.2177214+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "838cfb01-e782-4d7b-b3c6-b0147cf512db",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0076217f-1987-4484-abb3-128871825af2",
"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": "3a81bf49-f865-408f-8393-020fd4d9373c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "42265b50-d23a-451d-93c8-2b17720b21b9"
},
"suggested_date_start": "2026-06-02T03:50:10.2177214+00:00",
"skill_id": "6486a99c-8919-4ccb-b64d-a58391be4e3f",
"skill_code": "sample string 32",
"skill": {
"id": "4cd6549b-6932-4b82-ae08-d04e6b9c2c3c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6d8ff095-ed76-4eee-a3d2-d92161340ae9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc23fd0d-7b29-4012-98dd-78bc04871ca8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cd6b8bc-614f-47a5-84c4-72b56d4386cf",
"db_currency_id": "9150febf-7f3a-4383-8640-f64cb84b686c",
"db_language_id": "e1d4ebb3-a916-4431-9759-a9a01b9b9642",
"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-06-02T03:50:10.2177214+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b6289ffa-9227-4632-9d78-c8070583cd66",
"date_reported_by_company": "2026-06-02T03:50:10.2177214+00:00",
"id2": 36,
"company_id": "dcdc9882-f14f-4887-9a30-d6c9c3636873",
"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": "ebff23f0-d817-4376-b3ed-1f841c14169d",
"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-06-02T03:50:10.2177214+00:00"
},
"work_instruction_details_id": "0d09119f-bc1e-4d97-ac20-823dfac4fc7a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7d93b03e-f724-4c86-b5ea-b0653750b342",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e13dbde0-dbac-4906-a9fc-40e500743824",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T03:50:10.2177214+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": "3ff130a2-2cc5-4824-8692-db192ea896eb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T03:50:10.2177214+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.