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": "4bb74faf-61d3-40d1-953a-4a290c4c2d7e",
"jobs_id": "7a487548-ff6e-4466-a1c2-c4779d9a548e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b2b01501-5409-42ab-a14a-a24a0893d156",
"_parent_id": "ca22ebf5-19bd-49c0-9373-407c3e4e3a90",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db2af3f5-5b19-47bd-aa63-f69f41c451c7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7679348e-b515-4dc2-bc0f-05658488dcc7",
"_parent_id": "dd27e89c-90d3-45b4-baf4-f2d269d2e67b",
"root_parent_id": "9957e894-7147-45ce-a0c2-f7985f9fcc37",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8892bca-f932-43f6-8e40-b428cb7695ec",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e27a8233-5a69-4cfa-adff-5258486b9d5c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27a729b3-d218-473d-87af-d21c55fe5a66",
"_parent_code": "sample string 6",
"sales_organization_id": "169ec13a-39e9-4c33-b8a8-b320064e3846",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
},
"equipment_model_id": "5dc68f29-81ae-4068-a862-3b3aada59df7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "78d5f901-19d5-47c9-9f39-0aadc4cc7334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4285deaa-6bff-4587-8aa0-031022a71b15",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b9527a73-7deb-442d-af67-a51a1c85af4e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8eacbe6b-fa2a-49b0-9fcd-4062a4d8d062",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
},
"equipment_family_id": "a8c48fdb-852c-46e1-8ca9-f1439c0e8d86",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e27a8233-5a69-4cfa-adff-5258486b9d5c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27a729b3-d218-473d-87af-d21c55fe5a66",
"_parent_code": "sample string 6",
"sales_organization_id": "169ec13a-39e9-4c33-b8a8-b320064e3846",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
},
"date_in_production_since": "2026-09-29T01:36:00.8340583+00:00",
"date_out_of_production_since": "2026-09-29T01:36:00.8340583+00:00",
"date_end_support": "2026-09-29T01:36:00.8340583+00:00",
"sales_organization_id": "29aac73e-f290-4ce2-80d0-8532155491b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+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-09-29T01:36:00.8340583+00:00"
},
"project_status_id": "33f41eb1-4fac-4a02-80bc-c8095018b11f",
"project_status_code": "sample string 10",
"project_status": {
"id": "57ac5a33-0967-4c17-956b-094e8925d967",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b71210a-0d18-4f18-8276-4721608d7e83",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
},
"company_id": "e54abc20-e3c6-4932-9fd0-7802716d56b0",
"company_code": "sample string 12",
"db_address_id": "45617db4-3468-4850-ab98-3ef7dd5580fc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "825d82ac-ed76-4ada-b85b-79cded4358ff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "05fb1a08-8d5f-44a2-8600-e624d520ebba",
"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-09-29T01:36:00.8340583+00:00",
"date_create": "2026-09-29T01:36:00.8340583+00:00",
"date_update": "2026-09-29T01:36:00.8340583+00:00",
"updated_by_user_id": "1fd38f3a-fddc-442c-b358-fe107ecb53fa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-29T01:36:00.8340583+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-09-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-29T01:36:00.8340583+00:00",
"date_last_job": "2026-09-29T01:36:00.8340583+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-29T01:36:00.8340583+00:00",
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00",
"is_mobile_installation": true
},
"job_type_id": "9780de83-ce61-419b-b58c-983a0ce95973",
"job_type_code": "sample string 7",
"job_type": {
"id": "cce63518-119a-47d9-b013-bdc11cb510ad",
"name": "sample string 2",
"sales_organization_id": "ec615e7b-f0c7-402e-8b8e-62b01391c1e2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00",
"code": "sample string 7"
},
"job_priority_id": "d6d38f82-3518-49cf-9e13-eef5c7f66af9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4707e652-c080-439d-be35-6559716772df",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c080c22b-4cdb-4c18-b6ac-ba1572391fe1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
},
"job_status_id": "40cae54d-0266-4f22-98d7-3ef7f84f6dac",
"job_status_code": "sample string 11",
"db_address_id": "4cebd087-aa6f-4260-aaaa-61d2186eb2b2",
"contact_id": "e709c7a0-ad37-49bd-a251-1af6cb1aa9b9",
"requested_by_company_id": "cc62417e-947c-405b-8397-4e198cd18b7b",
"requested_by_contact_id": "fc17862d-8cf0-411e-b5e9-7ef37234ecf3",
"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-09-29T01:36:00.8340583+00:00",
"due_date": "2026-09-29T01:36:00.8340583+00:00",
"date_create": "2026-09-29T01:36:00.8340583+00:00",
"date_update": "2026-09-29T01:36:00.8340583+00:00",
"date_closed": "2026-09-29T01:36:00.8340583+00:00",
"suggested_user_id": "de3759ce-bbda-44ca-96f3-03df86d76b47",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7a7fd7a8-3840-4373-87b7-0adf768c2d30",
"db_language_id": "660a83d1-fdbb-4bf6-b950-33f55e053870",
"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-09-29T01:36:00.8340583+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "449ea2c2-1ea0-40de-baf4-b6dbb90581fc",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "914c0934-5c86-43a7-b540-51514162b50d",
"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": "60f98569-2d15-49ca-8fd2-27c404a5c7f2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "610d33ca-5741-42c6-8a1f-02e6cba5b6bd"
},
"suggested_date_start": "2026-09-29T01:36:00.8340583+00:00",
"skill_id": "6073941f-b282-485c-9394-d4a02c8f2c95",
"skill_code": "sample string 32",
"skill": {
"id": "7b009189-6200-4aa7-a48b-7d74a99c81b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4865ce0e-e1e9-4b47-ae16-606f9b96f466",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cee3c15-5711-4d59-af3d-9858918d81ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e02f4a49-765e-410f-9308-c37f207bbe35",
"db_currency_id": "a486708f-8476-4bfb-92b3-f743b89e57de",
"db_language_id": "7fbf121b-ed66-4a22-9f76-f18373a1300a",
"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-09-29T01:36:00.8340583+00:00"
},
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e1a1beeb-e646-434a-99f7-449ad6245154",
"date_reported_by_company": "2026-09-29T01:36:00.8340583+00:00",
"id2": 36,
"company_id": "1563b826-3816-4bf1-8a53-e1daccecf606",
"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": "a2ff9046-a3bf-45e3-ba56-4881f05a276e",
"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-09-29T01:36:00.8340583+00:00"
},
"work_instruction_details_id": "45e62151-6c69-4386-a152-8cdbed186371",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ac5d212f-80cc-4b23-aaea-8e328e6531d1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "63e03837-4614-4ec5-8a95-a3c07a966d38",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-29T01:36:00.8340583+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": "90d3c93c-d110-4129-ac53-8fbc2d277f24",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-29T01:36:00.8340583+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.