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": "ddca03a3-8166-4ab2-9e08-5584c7e2e53b",
"jobs_id": "86c16e2f-c280-41fb-b524-19c471c77433",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e92d5f40-da70-40c5-8773-2016fa3fa1ad",
"_parent_id": "a2790a35-7ba9-4bff-9da6-f0c44bd96d25",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d2b6b2c2-8721-4cc8-aea8-0b918ed6f8a9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b552949b-fb20-47a3-999a-a8f2188963bd",
"_parent_id": "8ca34db2-8471-45a5-83fa-5f505eeeef4c",
"root_parent_id": "27a43c46-9dbe-40c0-a7b0-7556978b5792",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "184bab05-598a-4d6d-889f-929c2b071490",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "19038271-c4aa-49aa-b26b-4a14fdd19f40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "91bdb419-2deb-4f97-83e7-efbd5c19aa86",
"_parent_code": "sample string 6",
"sales_organization_id": "1f43515b-4bb6-4119-926f-2c6503f1a827",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
},
"equipment_model_id": "7b774a55-d5da-4484-9bed-c5a3a7705e78",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "01b9eb8a-a884-4153-80ad-77358425ecf5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8211d1d0-57c0-4a2c-9256-b0347162edd1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "32cf495c-5fb8-4ee6-8bb1-de941d68a54f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "805be6b5-7dfd-4151-b622-1af6779d761a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
},
"equipment_family_id": "df6d71b5-d4a2-46ff-a82d-8086a4ea7b5b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "19038271-c4aa-49aa-b26b-4a14fdd19f40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "91bdb419-2deb-4f97-83e7-efbd5c19aa86",
"_parent_code": "sample string 6",
"sales_organization_id": "1f43515b-4bb6-4119-926f-2c6503f1a827",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
},
"date_in_production_since": "2026-03-18T06:47:21.0931584+00:00",
"date_out_of_production_since": "2026-03-18T06:47:21.0931584+00:00",
"date_end_support": "2026-03-18T06:47:21.0931584+00:00",
"sales_organization_id": "a713fdde-0234-41e8-835f-f1b0998bedd3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+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-03-18T06:47:21.0931584+00:00"
},
"project_status_id": "3d9faf5f-6539-4d8f-bbaa-8f30bd6dfe02",
"project_status_code": "sample string 10",
"project_status": {
"id": "f2b6d409-29a9-433c-91cf-56f8d9888052",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "74df81e0-a63e-4eca-98d2-6cb852d07edb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
},
"company_id": "87ce1e2d-f92d-4e6d-8575-2353f3169666",
"company_code": "sample string 12",
"db_address_id": "fcdfff1e-0c92-4e5b-aaad-6a3472efa61a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b3327a81-6561-49ee-99cd-53f35fe17197",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "86f8ddd9-f606-41fd-a069-2de0de964ba2",
"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-03-18T06:47:21.0931584+00:00",
"date_create": "2026-03-18T06:47:21.0931584+00:00",
"date_update": "2026-03-18T06:47:21.0931584+00:00",
"updated_by_user_id": "a47533ec-f400-4c54-b902-cbca4cb14990",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-18T06:47:21.0931584+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-03-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-18T06:47:21.0931584+00:00",
"date_last_job": "2026-03-18T06:47:21.0931584+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-18T06:47:21.0931584+00:00",
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00",
"is_mobile_installation": true
},
"job_type_id": "ed087a20-6706-4a4e-9193-cc8a026fcdf2",
"job_type_code": "sample string 7",
"job_type": {
"id": "4179ea04-737a-4948-9049-4317adc9d073",
"name": "sample string 2",
"sales_organization_id": "2550ed60-3cc8-4eb5-9a6e-98cdaf65b5ac",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00",
"code": "sample string 7"
},
"job_priority_id": "eb3f2d24-1b7a-4567-a98b-8360ea6a2be3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6e42e3c2-e90d-4f0d-a5b4-2a590c27a3cd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "12b06558-3264-4ca8-b7c5-e2e3efb3a9c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
},
"job_status_id": "30a48250-8e8a-4240-92cd-d8afb04de387",
"job_status_code": "sample string 11",
"db_address_id": "0a775041-163f-4f4e-8fc9-9361d4b72807",
"contact_id": "cc1c1e45-7909-4eb5-8c6b-9d33c35ea409",
"requested_by_company_id": "b591155e-92f6-46b8-b4cc-16e6b04a80ec",
"requested_by_contact_id": "d2d4e75b-e168-49a3-a682-54c56966950a",
"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-03-18T06:47:21.0931584+00:00",
"due_date": "2026-03-18T06:47:21.0931584+00:00",
"date_create": "2026-03-18T06:47:21.0931584+00:00",
"date_update": "2026-03-18T06:47:21.0931584+00:00",
"date_closed": "2026-03-18T06:47:21.0931584+00:00",
"suggested_user_id": "0a288c93-a10f-4d17-8083-abfceed5208f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "357d6b57-336e-4390-8452-94317d1383f2",
"db_language_id": "63340fbd-52fa-469a-8c2c-285fe3508886",
"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-03-18T06:47:21.0931584+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0f601aaa-d6de-4949-a107-87fd3636ab3a",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6608d781-546b-43b8-855e-341708b6da35",
"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": "eef045b6-61cc-4645-b79d-8ef215434a5f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c8ffae2f-ddd7-4a5b-b3f7-ae261f23e14b"
},
"suggested_date_start": "2026-03-18T06:47:21.0931584+00:00",
"skill_id": "55e02cbd-82db-4a89-8eeb-04bba8225576",
"skill_code": "sample string 32",
"skill": {
"id": "8ad55c2d-ad42-4141-9ecf-99b791530192",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "450196f6-8fd0-442f-98af-0360e894bf69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a017618d-e277-42f7-9c66-05da687e3b5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af11b1d9-3107-468a-8042-beb5ffb8da4f",
"db_currency_id": "bcd4992e-b4f7-4b66-b770-1cb187d14674",
"db_language_id": "47c48d01-8fe0-450f-9387-d178bcf1bc66",
"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-03-18T06:47:21.0931584+00:00"
},
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8336fec2-9672-49d7-a29e-f218076e93fb",
"date_reported_by_company": "2026-03-18T06:47:21.0931584+00:00",
"id2": 36,
"company_id": "2683af1a-7156-46f3-b68a-4a7b1df57fda",
"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": "f7a347ac-6812-435e-b1a5-7173864b4f56",
"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-03-18T06:47:21.0931584+00:00"
},
"work_instruction_details_id": "2eda6bb4-1a97-4723-ab20-4627555b72e2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55a79f55-d8d8-4540-9523-9b0823c563c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "26d4e9a0-5727-4525-baef-be1bebc43695",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-18T06:47:21.0931584+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": "b6f1fbc5-e132-4621-8a6e-6e183f0bd729",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-18T06:47:21.0931584+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.