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": "62d11341-6a33-483c-b9d8-9f2c2e5d67fa",
"jobs_id": "cb36887e-08f7-48de-a07f-9da7ac08e32f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d8a0a475-5360-495e-a6b9-dbcd67954955",
"_parent_id": "5eb8b321-8cb4-4854-b87d-238c0fa990a2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "55321f4e-61a2-4769-98f9-85c4a058523d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2e60c9e6-6118-47c0-9724-c190ead734c0",
"_parent_id": "594f7951-e2f6-4b3f-ab82-3d83fe377855",
"root_parent_id": "c4f80b4c-e6ff-49bd-b3c7-e7e1a7072f39",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "696525fb-82f4-4ae8-aba9-abb923cb0af0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4d0199f8-7083-4766-b1c3-e007d5fd8d08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78159791-9b46-4e8b-8603-d477f843ab60",
"_parent_code": "sample string 6",
"sales_organization_id": "851ee10b-9e15-4eb8-aa4c-493fa20c0d5b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
},
"equipment_model_id": "8171572b-e5e0-4efa-acf3-b91fe182e203",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1770919a-a24c-4535-a8c6-5f33ceb35e2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "06676314-5ef3-45d3-a01e-d4866e103a45",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "71a0b36d-5408-484b-8536-b702cbf1f689",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ae64b7d-a3ac-42f2-bc15-49df75a59093",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
},
"equipment_family_id": "0ad7d776-da62-46b1-aa29-d77519d19410",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4d0199f8-7083-4766-b1c3-e007d5fd8d08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78159791-9b46-4e8b-8603-d477f843ab60",
"_parent_code": "sample string 6",
"sales_organization_id": "851ee10b-9e15-4eb8-aa4c-493fa20c0d5b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
},
"date_in_production_since": "2026-05-07T06:48:02.3902625+00:00",
"date_out_of_production_since": "2026-05-07T06:48:02.3902625+00:00",
"date_end_support": "2026-05-07T06:48:02.3902625+00:00",
"sales_organization_id": "337ef353-5503-42ec-b069-246a958b39cc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+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-05-07T06:48:02.3902625+00:00"
},
"project_status_id": "d828abea-8601-49cd-b083-203eeb0e6e04",
"project_status_code": "sample string 10",
"project_status": {
"id": "0275f348-7e2b-4149-b7cb-0f0d96d98171",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "72e281b3-998a-4593-a0a0-f3c80361feed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
},
"company_id": "0aeaaa13-0b18-4f85-889b-f740b7f3af47",
"company_code": "sample string 12",
"db_address_id": "84312793-c85f-44d3-b07c-eebfb0db9924",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "74c48424-0d15-41e1-b739-63d477efd43c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cc3b3053-74b1-4f5c-a525-03e58e5b5fd9",
"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-05-07T06:48:02.3902625+00:00",
"date_create": "2026-05-07T06:48:02.3902625+00:00",
"date_update": "2026-05-07T06:48:02.3902625+00:00",
"updated_by_user_id": "83d37e1e-e8dc-401f-96d6-1bd7439de336",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T06:48:02.3902625+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-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T06:48:02.3902625+00:00",
"date_last_job": "2026-05-07T06:48:02.3902625+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T06:48:02.3902625+00:00",
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00",
"is_mobile_installation": true
},
"job_type_id": "76b2ba37-b8fd-48b6-a85d-82dcc92c98f1",
"job_type_code": "sample string 7",
"job_type": {
"id": "af2fea7b-8c6b-428b-9ff1-8c4fd716bff6",
"name": "sample string 2",
"sales_organization_id": "3d9767b1-d7fc-48a6-8cb6-10060915c26d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00",
"code": "sample string 7"
},
"job_priority_id": "bbe302c9-8882-45c0-8eac-e2a2288734bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "75ee5f50-31e6-4dde-8b59-01a50a981ef1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ea7bbf9e-3f47-45c9-85c8-cbba1b0e8248",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
},
"job_status_id": "52d77943-76ff-4521-a5d7-c1d0de234e49",
"job_status_code": "sample string 11",
"db_address_id": "3533b92f-f4e3-422c-ab16-02b1ed149188",
"contact_id": "8e44552c-c573-4dc9-8296-837d6f73a80b",
"requested_by_company_id": "3c93977e-09c7-4437-9103-b58bfac66292",
"requested_by_contact_id": "f90715ef-b813-4d5b-b270-e3ab7e915316",
"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-05-07T06:48:02.3902625+00:00",
"due_date": "2026-05-07T06:48:02.3902625+00:00",
"date_create": "2026-05-07T06:48:02.3902625+00:00",
"date_update": "2026-05-07T06:48:02.3902625+00:00",
"date_closed": "2026-05-07T06:48:02.3902625+00:00",
"suggested_user_id": "cfa2d14e-9119-4c79-859b-e848f7224791",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "056cf2df-0581-4090-9e5f-a2ff17ee4113",
"db_language_id": "08f3ad1a-7598-419b-b8e4-00fe5489ae4d",
"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-05-07T06:48:02.3902625+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c98b07fb-3e90-462f-a415-ca624ce4b397",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "985a10c6-a56c-479b-8ec5-e264bf0ee206",
"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": "2c618c02-12f9-4bea-ac6a-4e89c8bcdd92",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41c8121a-b763-452a-a609-5ca55686df4c"
},
"suggested_date_start": "2026-05-07T06:48:02.3902625+00:00",
"skill_id": "0a93d935-9614-4587-b299-9044a51c5d96",
"skill_code": "sample string 32",
"skill": {
"id": "16b1ef6f-f9c9-489c-bdcd-77978f1275d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c32640f0-c46e-46ea-9970-faf56aad4790",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e49fd8e4-6242-43d6-997b-71b422efa472",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8059806-9e5d-4e0a-b515-cd20a275325a",
"db_currency_id": "9249d08e-e90d-4ef4-ae43-2ffc9fb1fe62",
"db_language_id": "73edf91c-b9e3-4324-af28-7e2288fabb50",
"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-05-07T06:48:02.3902625+00:00"
},
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9f26c728-8ffd-455b-bf38-3d55efba3714",
"date_reported_by_company": "2026-05-07T06:48:02.3902625+00:00",
"id2": 36,
"company_id": "e21b639f-9614-41cd-a698-8328eda600a0",
"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": "19366d43-8890-4880-ac7a-425fd5682c2f",
"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-05-07T06:48:02.3902625+00:00"
},
"work_instruction_details_id": "4c4bfe96-af7f-4b8d-8753-31637f48be1a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8c1fc265-0486-4e1e-a568-8464a16f783d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7cf40e1f-7821-4358-9991-36bd263fd435",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T06:48:02.3902625+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": "b3ac59da-f6cb-419e-9e9a-c83d674d50f9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T06:48:02.3902625+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.