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": "7c5e4337-23ce-4cf7-b858-a691ec5a3691",
"jobs_id": "e33a9a98-c70a-41c2-9e4f-3be4ee2e1cde",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "10bf1dec-eea0-4d2c-9d78-d659cfa29e58",
"_parent_id": "2e3fe9e2-a153-493d-9ed1-27dccbd156b2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7ad40524-c6fa-4ccf-aa81-d01222cc89d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cb737132-c924-469a-9e53-33f09b136a8b",
"_parent_id": "12f6c14d-6ab8-4d3f-8837-1a9ea4709977",
"root_parent_id": "3a40841a-9aac-4daa-a697-a6b1f626aab6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fef6b195-068f-416b-ab6c-cece5f43c452",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f7d8bbfb-3c23-4de7-8bbf-eab7023861b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bfb7c7ac-728e-4c1e-8d06-3305e284b75a",
"_parent_code": "sample string 6",
"sales_organization_id": "52469d9d-5d71-47fe-846b-c0ff55209018",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00"
},
"equipment_model_id": "2461ca0d-a4c2-4a76-a026-0fde554836b9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1d1718f0-1bf8-47c9-9568-7c95520c2434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a5f0e7bc-5bde-4e61-9af5-0e17fad6a2a5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "932061da-a506-4014-bb13-75bc72fb9763",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "08075383-c615-4db5-9bfd-a277cb539974",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00"
},
"equipment_family_id": "14df118f-1d21-4b67-addf-7e385e17b893",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f7d8bbfb-3c23-4de7-8bbf-eab7023861b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bfb7c7ac-728e-4c1e-8d06-3305e284b75a",
"_parent_code": "sample string 6",
"sales_organization_id": "52469d9d-5d71-47fe-846b-c0ff55209018",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00"
},
"date_in_production_since": "2025-12-16T20:46:43.9497597+00:00",
"date_out_of_production_since": "2025-12-16T20:46:43.9497597+00:00",
"date_end_support": "2025-12-16T20:46:43.9497597+00:00",
"sales_organization_id": "fccc47b0-81b3-49e4-b3b0-508dbe608805",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+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": "2025-12-16T20:46:43.9497597+00:00"
},
"project_status_id": "917fa2ab-9022-46ef-8788-9cb98431d421",
"project_status_code": "sample string 10",
"project_status": {
"id": "8d0908be-80d0-4694-99c8-6c2c03986d87",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1298d86e-e247-41b2-8592-93a04ce475cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00"
},
"company_id": "42b6e563-37d8-4c7b-bd99-f2eccbb06903",
"company_code": "sample string 12",
"db_address_id": "347ffbba-6a2e-4a60-9816-457d005ac9f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "802d1131-6b50-46bd-8434-60462d556060",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6f29daa6-310d-43df-901f-8d5d2cefff46",
"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": "2025-12-16T20:46:43.9497597+00:00",
"date_create": "2025-12-16T20:46:43.9497597+00:00",
"date_update": "2025-12-16T20:46:43.9497597+00:00",
"updated_by_user_id": "dfd31918-7eb1-45ec-9275-bce75d7f6bbf",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-16T20:46:43.9497597+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": "2025-12-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-16T20:46:43.9497597+00:00",
"date_last_job": "2025-12-16T20:46:43.9497597+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-16T20:46:43.9497597+00:00",
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00",
"is_mobile_installation": true
},
"job_type_id": "adebcf0d-7b7f-4675-a5b0-43f495234a47",
"job_type_code": "sample string 7",
"job_type": {
"id": "42f6389f-d5d1-400a-b452-e8cf7e9eabba",
"name": "sample string 2",
"sales_organization_id": "d6012cd7-c8e7-4018-a6bf-afa0d92cb151",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00",
"code": "sample string 7"
},
"job_priority_id": "6a831be2-f7e1-404d-a43c-2c5302e83f98",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "10bea764-acf5-44fb-bd30-cc409412289c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d45943d9-1655-49a9-aa19-3fccf87ebc65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00"
},
"job_status_id": "54dc125b-7ae9-4344-a898-44bfb8c67c61",
"job_status_code": "sample string 11",
"db_address_id": "211d39e2-e6a5-4410-bbf9-028d2f92c680",
"contact_id": "49cfc251-dde3-4f44-9978-da9ad399b9e4",
"requested_by_company_id": "f44d2346-d90d-44f1-bfb9-9dd489b64f05",
"requested_by_contact_id": "a197e47b-3488-4b63-b649-048f5540c8f2",
"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": "2025-12-16T20:46:43.9497597+00:00",
"due_date": "2025-12-16T20:46:43.9497597+00:00",
"date_create": "2025-12-16T20:46:43.9497597+00:00",
"date_update": "2025-12-16T20:46:43.9497597+00:00",
"date_closed": "2025-12-16T20:46:43.9497597+00:00",
"suggested_user_id": "8dc06844-8ab4-44ba-924e-442b5da6d4a2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e17c6cba-9ba8-4064-8d64-7a54534e6544",
"db_language_id": "f7eea44c-3efb-46ea-9c58-90e250f574de",
"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": "2025-12-16T20:46:43.9497597+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "926ad65a-3776-4d1e-baa5-8191cc08780b",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "99223916-dd12-46c9-9da3-d164423fb291",
"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": "b49bfd4e-c5d1-4e03-9b5c-b3f9731ad88d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "93788b17-03a2-4cca-89db-516463f74bd8"
},
"suggested_date_start": "2025-12-16T20:46:43.9497597+00:00",
"skill_id": "71236c3e-21dc-4f0f-af5b-d960b625ef4e",
"skill_code": "sample string 32",
"skill": {
"id": "f00b7cc2-1379-4fa4-9770-5c2c663ff7cd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8745d85a-1858-4d46-ac32-99e273999b03",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "434b3e41-7428-4da2-93f3-9581a56cf9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbd6e2d-53c7-4b8f-af78-cc1320baae96",
"db_currency_id": "8357a06a-6e93-4786-8be0-d2580e5eb95d",
"db_language_id": "42a6280e-4688-4452-82ce-503cbafd98ec",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"modified_dateutc": "2025-12-16T20:46:43.9497597+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4ad63c42-cdef-4e02-85bf-17597d76c445",
"date_reported_by_company": "2025-12-16T20:46:43.9497597+00:00",
"id2": 36,
"company_id": "3e355c72-7cfb-4507-b9f0-b010a7d58fa8",
"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": "71a749ec-68ee-4234-810d-c521da73ab85",
"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": "2025-12-16T20:46:43.9497597+00:00"
},
"work_instruction_details_id": "db0ddd45-0af3-4458-a007-31b7e27e182b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c844e64e-45b6-4933-91cd-ea6976c936cf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1a52deb8-5d03-483b-a0e1-453e1f4039dc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-16T20:46:43.9497597+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": "b5941032-9718-4428-833e-0509ce95e465",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-16T20:46:43.9652072+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.