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": "4491b58a-7603-449b-b458-0092ae2d4935",
"jobs_id": "ed41ccbb-624f-4aa5-80c5-e65a2de5b355",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ac20968e-012a-4a60-b801-b8e7a04d2174",
"_parent_id": "e90cd230-6661-4ddf-b60f-7c9dde743f9c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "27e7b281-d4fb-48b9-ac1f-957fbe5c6077",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ede6bc18-60e0-40bb-ba50-4f8896b492d0",
"_parent_id": "8a9bd742-d300-476e-89c2-0edf5a825065",
"root_parent_id": "9e4cac71-61a4-4ec1-87ab-aa48da29d018",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "63ef1b76-78db-4532-a477-f8b111e2e069",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d47d1914-3968-4c40-a7d2-4eb70961ca6b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "53e51a35-b264-46cd-aed8-ccf896669653",
"_parent_code": "sample string 6",
"sales_organization_id": "63d7011c-2235-44c3-8182-d4bd1ed9de21",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"modified_dateutc": "2026-06-15T00:09:34.2877603+00:00"
},
"equipment_model_id": "1e4de398-2028-4ded-a1cc-034651039d21",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fe9f067c-c26d-4094-ae1f-38f8d5b9f3c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1fd12cb0-38d4-40ad-a2ea-96197bb0d718",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5710f9a9-2662-4539-a39f-086d389fc499",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7fe54fc4-6b01-4992-bf70-a84bcd9b8227",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00"
},
"equipment_family_id": "6e10d146-b70d-4aff-8153-4a2979f8959a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d47d1914-3968-4c40-a7d2-4eb70961ca6b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "53e51a35-b264-46cd-aed8-ccf896669653",
"_parent_code": "sample string 6",
"sales_organization_id": "63d7011c-2235-44c3-8182-d4bd1ed9de21",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"modified_dateutc": "2026-06-15T00:09:34.2877603+00:00"
},
"date_in_production_since": "2026-06-15T00:09:34.3033816+00:00",
"date_out_of_production_since": "2026-06-15T00:09:34.3033816+00:00",
"date_end_support": "2026-06-15T00:09:34.3033816+00:00",
"sales_organization_id": "8e18e9eb-1f56-4fd7-b991-c2db152d2890",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+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-15T00:09:34.3033816+00:00"
},
"project_status_id": "672959f0-c81f-4208-8b20-9b9da4c4ac8f",
"project_status_code": "sample string 10",
"project_status": {
"id": "b7cc1df0-d292-4864-958c-62bf22a5a4ee",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b4740380-c377-48a4-9c81-e2ecda345ac9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00"
},
"company_id": "97959373-61ee-48df-a7e8-2893f1abe22f",
"company_code": "sample string 12",
"db_address_id": "3acaf4b0-f617-4fff-804e-f5605b658f2d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c3cb8875-e3d5-4e4a-84c5-10066d5df21a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b501690b-1720-40cf-88fc-a9c217026d76",
"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-15T00:09:34.3033816+00:00",
"date_create": "2026-06-15T00:09:34.3033816+00:00",
"date_update": "2026-06-15T00:09:34.3033816+00:00",
"updated_by_user_id": "49236313-7390-4658-9fb7-e7cdf2a3cb96",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-15T00:09:34.3033816+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-15T00:09:34.3033816+00:00",
"date_last_job": "2026-06-15T00:09:34.3033816+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-15T00:09:34.3033816+00:00",
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00",
"is_mobile_installation": true
},
"job_type_id": "2c8b7d84-2dc1-4364-9af9-208e89302b0f",
"job_type_code": "sample string 7",
"job_type": {
"id": "d281f4e1-cef2-4e43-bc3d-dcf0262552ad",
"name": "sample string 2",
"sales_organization_id": "cf4d2215-0c7a-4eef-8eae-bf04f7ac5b2b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00",
"code": "sample string 7"
},
"job_priority_id": "f724131c-3471-44b2-9fc0-ce034b58585b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "35979805-3e19-4eca-bd07-2da120d97c0e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "be1d422a-2a8f-4408-b993-605253927cd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00"
},
"job_status_id": "ecd5b80b-ab0e-4254-9620-7e0e4ee789f2",
"job_status_code": "sample string 11",
"db_address_id": "4af1207b-99e4-4d2f-8ea7-ff71f8607a79",
"contact_id": "17ad357d-5069-435c-bb75-ff0301c984b3",
"requested_by_company_id": "ef11f21d-c9c3-4a19-ba70-bb107d69a34c",
"requested_by_contact_id": "77dd3ee9-381d-4ee3-a9f8-218f0b12edb4",
"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-15T00:09:34.3033816+00:00",
"due_date": "2026-06-15T00:09:34.3033816+00:00",
"date_create": "2026-06-15T00:09:34.3033816+00:00",
"date_update": "2026-06-15T00:09:34.3033816+00:00",
"date_closed": "2026-06-15T00:09:34.3033816+00:00",
"suggested_user_id": "4ec30377-451c-4159-8daa-926394c6806b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4fcbaceb-a5cf-4098-8944-8edb0b9cdc44",
"db_language_id": "428025bc-3f78-4278-b0cb-0421d7a0cc8b",
"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-15T00:09:34.3033816+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "710de7e3-854b-48a7-822d-fab02b91482a",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "76ab30b5-0dca-4bdd-a736-fc764caf8504",
"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": "dc6d9ae1-ccc6-4dce-8dca-70e589a4ea8f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "01d6845e-4ec0-4ac6-a36e-fd6c62381860"
},
"suggested_date_start": "2026-06-15T00:09:34.3033816+00:00",
"skill_id": "85f2bab3-535a-4031-8295-cdee96bed941",
"skill_code": "sample string 32",
"skill": {
"id": "eaad1e4e-0bd0-4724-8abb-207680524eaa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "00c13120-3f16-4cf0-a41f-49973e340052",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1f23c01f-e4a8-4590-96cd-112026b7e7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "508a4994-3444-40b3-be3b-d27736715a47",
"db_currency_id": "b96bd3da-a7e8-4ee8-a2d5-e2d70916d98e",
"db_language_id": "9851b97f-f6ab-438a-b85b-fb78f28cd723",
"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-15T00:09:34.2877603+00:00"
},
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a8d12ad4-bdf7-4f39-912d-5126633a96a7",
"date_reported_by_company": "2026-06-15T00:09:34.3033816+00:00",
"id2": 36,
"company_id": "1294a580-0a44-4f09-a394-7c114fbc3c5d",
"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": "73c38b5a-131f-4149-8c89-471a183ee908",
"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-15T00:09:34.3033816+00:00"
},
"work_instruction_details_id": "b7b7ab45-056f-4148-a62a-5baaf5427655",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6e7d7377-ee7f-4072-82ad-7ea71e433304",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "44ad335d-9bce-412f-af3e-1a9099ed6a09",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-15T00:09:34.3033816+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": "e18bde02-eacf-44b5-9292-e6ef9ec1fb6e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-15T00:09:34.3033816+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.