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": "12b7c18d-1a94-4d02-8f88-112f8c536359",
"jobs_id": "e1e1af92-1b6c-4dbe-9a39-4a22f201300d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cff94fa6-6289-4a48-b25a-bcbd76cd3914",
"_parent_id": "a1bca00a-acbb-4ef1-98f2-6e2ee4b13054",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c2c6b0b3-8ec7-4eef-a994-bd5d653c2b47",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7741ea56-bde4-4ad2-a2c3-f519ac804a02",
"_parent_id": "f551c610-e5da-4fd2-ae7c-b7c97a3563b5",
"root_parent_id": "a6bd0ea8-4d8d-4c27-bd31-3b2986e00d48",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f0824393-9cba-4350-9c65-2e2d88dffd3a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ece0d1a0-d8e1-41eb-88b5-7f71cb42db8b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3efdc757-4405-4fb3-a741-b1b09937dac6",
"_parent_code": "sample string 6",
"sales_organization_id": "a1299ebb-551b-4365-96ab-b6da77e310fd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"modified_dateutc": "2026-06-18T01:35:51.3341862+00:00"
},
"equipment_model_id": "ede3e07d-61bc-4aca-8e55-db7efe8ba0a2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a9bef24-47f6-4481-8665-800bf994f16c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b3d05176-76cf-4d42-acba-cd8fa84616b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e1d5a942-9cf5-4831-a9fc-aa6458e4c099",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ffdf63b2-fa01-4f34-9a09-7708e1d2b093",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"modified_dateutc": "2026-06-18T01:35:51.3341862+00:00"
},
"equipment_family_id": "321a44f8-2716-4c89-8c4f-7a57c5cf5322",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ece0d1a0-d8e1-41eb-88b5-7f71cb42db8b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3efdc757-4405-4fb3-a741-b1b09937dac6",
"_parent_code": "sample string 6",
"sales_organization_id": "a1299ebb-551b-4365-96ab-b6da77e310fd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"modified_dateutc": "2026-06-18T01:35:51.3341862+00:00"
},
"date_in_production_since": "2026-06-18T01:35:51.3341862+00:00",
"date_out_of_production_since": "2026-06-18T01:35:51.3341862+00:00",
"date_end_support": "2026-06-18T01:35:51.3341862+00:00",
"sales_organization_id": "8123e50e-2cca-4ddd-b491-de91707ad286",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+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-18T01:35:51.3341862+00:00"
},
"project_status_id": "63f74fa1-9db8-4e5c-ae12-cf14c3dbb1a9",
"project_status_code": "sample string 10",
"project_status": {
"id": "a6793eb1-a627-4e5e-bfec-3797a1095ccb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "34afd7e4-d096-4bea-9fe4-4e39b3515b28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00"
},
"company_id": "8697c5da-56fa-44db-9eb6-62f3fa5cbf54",
"company_code": "sample string 12",
"db_address_id": "38a47446-ad7b-4b04-a3ae-80333e934ea1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f8603243-2778-4aee-a652-dd8bb9110661",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9f9db18d-05fb-461b-9f49-e1c1d32f9bb8",
"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-18T01:35:51.3498135+00:00",
"date_create": "2026-06-18T01:35:51.3498135+00:00",
"date_update": "2026-06-18T01:35:51.3498135+00:00",
"updated_by_user_id": "ad9f58a3-c3ef-43ce-a24c-aaf7970a3142",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-18T01:35:51.3498135+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-18T01:35:51.3498135+00:00",
"date_last_job": "2026-06-18T01:35:51.3498135+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-18T01:35:51.3498135+00:00",
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00",
"is_mobile_installation": true
},
"job_type_id": "20618204-652c-48d7-a93b-b789da1902ec",
"job_type_code": "sample string 7",
"job_type": {
"id": "28a135b8-00a1-4f60-aed6-ac32616e2dce",
"name": "sample string 2",
"sales_organization_id": "bced7724-fd86-4013-be26-54af3451b8d4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00",
"code": "sample string 7"
},
"job_priority_id": "ee5175f9-cd47-4b84-867d-b9f32221c8fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "92aa06fb-6533-4d8c-8700-a1331366d5fb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "64631797-ba91-4618-bc16-ce4e077ee936",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00"
},
"job_status_id": "96cf9273-841e-42cc-921c-0685a5e8a1c8",
"job_status_code": "sample string 11",
"db_address_id": "7a254fed-54cc-403f-80d4-8f5d66c5b3fb",
"contact_id": "18101647-2412-432a-8df7-e45a5cd44700",
"requested_by_company_id": "ab4aa4c0-a67b-4d93-9f66-77845e50e756",
"requested_by_contact_id": "69d9a99e-95a7-4def-8f52-e2615add3ba1",
"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-18T01:35:51.3498135+00:00",
"due_date": "2026-06-18T01:35:51.3498135+00:00",
"date_create": "2026-06-18T01:35:51.3498135+00:00",
"date_update": "2026-06-18T01:35:51.3498135+00:00",
"date_closed": "2026-06-18T01:35:51.3498135+00:00",
"suggested_user_id": "f9854fee-87fa-4faf-8f8b-54e9a825078a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1a2d605b-3598-4763-8692-413590614aff",
"db_language_id": "851f559f-db57-4275-980a-4cadbe90b317",
"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-18T01:35:51.3498135+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e2b07ddc-b38f-412f-a78e-3dbc7830e9fe",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6ec0aac0-9cc7-437d-ae20-ea38cc946161",
"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": "de3519d6-d593-45cd-b067-6dd8180f4e1a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "35d11ead-efea-46dd-b9f0-bc269687237a"
},
"suggested_date_start": "2026-06-18T01:35:51.3498135+00:00",
"skill_id": "02f30617-d826-4d41-b870-0d4280bb9bf0",
"skill_code": "sample string 32",
"skill": {
"id": "f0b64caa-0c86-4a38-b41c-ba767e40940c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7e4c8d00-2964-4283-be5d-1a9f9d308986",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70a1b5af-12cd-45e4-a0b0-be6e667a954a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d9984c1-d1b9-442a-8676-d82bb8d05d9e",
"db_currency_id": "239205b4-4d15-4de2-86c0-6d186159c308",
"db_language_id": "e364085a-5e61-4814-ac83-fb691b057c95",
"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-18T01:35:51.3341862+00:00"
},
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3bab9a60-3987-4374-b326-d6952e906f56",
"date_reported_by_company": "2026-06-18T01:35:51.3498135+00:00",
"id2": 36,
"company_id": "70e5a603-aa73-4e95-bc80-a8dec2e9a7f7",
"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": "8ad41697-028b-47eb-825c-97240995e2fe",
"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-18T01:35:51.3498135+00:00"
},
"work_instruction_details_id": "5d6a9f44-f240-4618-8d25-8e2496ebebf8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "87ba4da0-a528-4e3e-baf4-68f335663d85",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1cc5a175-50e9-4e5d-938b-a4bc44473890",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-18T01:35:51.3498135+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": "dfab710f-6af7-4763-91bc-08ba685339dd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-18T01:35:51.3498135+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.