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": "eea95e5f-fa40-4963-a5a5-13202a2dec05",
"jobs_id": "676b1f83-e435-4d19-83a3-55c3248ec8b9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "12ad94d4-8ebb-4d21-bade-9276f14166c2",
"_parent_id": "3895eef6-e65f-4705-b9b4-2ca45ce3639e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "43c3abd1-4072-452e-8ccd-779633717688",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b7b7ec6-374d-478c-84ab-4a4cd6cb4f8d",
"_parent_id": "712d1ccf-20eb-4cc3-92b9-f859ce8bc850",
"root_parent_id": "88ab3498-b131-4c45-a1d3-c398fb408d6f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bcaa971a-46de-4df1-8743-479cb9b2ac1f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1832174d-899a-450f-8543-0459696b23a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abae6dad-4d5b-4160-b450-f3f1bba372cb",
"_parent_code": "sample string 6",
"sales_organization_id": "895ec61b-b7b6-4010-ae27-1a296a48990f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
},
"equipment_model_id": "bf988327-04a4-43e9-b79e-ff6f9f7deaff",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "98b9a480-fe5f-4ec1-bc74-499589ee1296",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8a9d26b2-308e-40ff-9742-b6dbe01db369",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cd4490bf-d135-40b0-b4f6-38ee76c0c7b5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a3d61c64-1d20-49d3-829d-6b3781de944d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
},
"equipment_family_id": "0ef060c2-0ad2-4421-8e5d-3f8d162afa86",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1832174d-899a-450f-8543-0459696b23a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abae6dad-4d5b-4160-b450-f3f1bba372cb",
"_parent_code": "sample string 6",
"sales_organization_id": "895ec61b-b7b6-4010-ae27-1a296a48990f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
},
"date_in_production_since": "2026-07-24T07:27:42.2746076+00:00",
"date_out_of_production_since": "2026-07-24T07:27:42.2746076+00:00",
"date_end_support": "2026-07-24T07:27:42.2746076+00:00",
"sales_organization_id": "980d1aeb-3158-447f-86b6-a0246bb10ca9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+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-07-24T07:27:42.2746076+00:00"
},
"project_status_id": "0444c6e4-22a4-4dc6-972b-e8db3ba60224",
"project_status_code": "sample string 10",
"project_status": {
"id": "85cb5b51-ad74-45ac-8995-ebb644b679f1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ab0a694a-5a4a-4cf6-9f1c-a1ac1786a718",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
},
"company_id": "f5d495fb-2d23-4ed8-8a4b-9bdcba6559d9",
"company_code": "sample string 12",
"db_address_id": "d0fe6b9b-2740-4f4b-9b4e-bee4af5fcf23",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3ebd882a-cd77-4122-a6a3-82ea0d2946cb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd30237f-49de-434d-ab5a-312dfff3b345",
"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-07-24T07:27:42.2746076+00:00",
"date_create": "2026-07-24T07:27:42.2746076+00:00",
"date_update": "2026-07-24T07:27:42.2746076+00:00",
"updated_by_user_id": "719cb6b8-6883-4339-8572-18aa7a363df6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-24T07:27:42.2746076+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-07-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-24T07:27:42.2746076+00:00",
"date_last_job": "2026-07-24T07:27:42.2746076+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-24T07:27:42.2746076+00:00",
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00",
"is_mobile_installation": true
},
"job_type_id": "c496d4df-7264-48af-93f2-84532a53f527",
"job_type_code": "sample string 7",
"job_type": {
"id": "59fe0875-1beb-4b4f-afa3-85021bd596fb",
"name": "sample string 2",
"sales_organization_id": "78219f27-d259-4a99-8a43-d031d344f558",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00",
"code": "sample string 7"
},
"job_priority_id": "8b5ff5e0-fe2f-49f0-a203-289a08373603",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f1bdf358-fdd7-4fc3-872b-e6f14c189a84",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d94c2e2e-1d46-4ab9-81ff-e894a0896108",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
},
"job_status_id": "2325e2a7-e631-43ef-b8d6-02e9835bf6c5",
"job_status_code": "sample string 11",
"db_address_id": "096d19a9-ff36-4bd2-9937-c52f5f650ee9",
"contact_id": "790936ed-ad0f-4bcb-b053-e31792994a77",
"requested_by_company_id": "1d62e3cb-0f39-443a-a4ca-5e3928d4fa3e",
"requested_by_contact_id": "325f8bdc-f96b-4db5-9d06-8aeb3051cfac",
"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-07-24T07:27:42.2746076+00:00",
"due_date": "2026-07-24T07:27:42.2746076+00:00",
"date_create": "2026-07-24T07:27:42.2746076+00:00",
"date_update": "2026-07-24T07:27:42.2746076+00:00",
"date_closed": "2026-07-24T07:27:42.2746076+00:00",
"suggested_user_id": "f961cd76-8230-4673-b711-513a1b241b9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6472ab3a-bd2d-477b-a7e0-425801c82d15",
"db_language_id": "f599f8a5-96ea-4a24-89bf-2b52465c49de",
"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-07-24T07:27:42.2746076+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e9838703-0337-4cd0-8cc0-6b598c8db2aa",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5aef1979-17ec-4677-a1bc-169f64e3a151",
"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": "e435e178-1ac6-4c4b-8a23-1c01c5743822",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "40a726db-5b88-45c1-9475-957f6f5cbf62"
},
"suggested_date_start": "2026-07-24T07:27:42.2746076+00:00",
"skill_id": "e39853fa-ae94-4dbf-931a-296aee7d9edd",
"skill_code": "sample string 32",
"skill": {
"id": "cd293c21-df95-4b60-919c-18c286c7a1c3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "64c53f2f-79f6-42b2-b87b-de2e41d81540",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae7328f0-32e1-4349-93b0-1d217414130e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3b70426-1ab6-47df-a381-581e1628c762",
"db_currency_id": "d76be13e-79ac-477b-be41-c1715768957d",
"db_language_id": "7083762a-bc13-421d-b134-d2873397ee1f",
"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-07-24T07:27:42.2746076+00:00"
},
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "86a92472-dd90-4d81-9b48-672029832e0e",
"date_reported_by_company": "2026-07-24T07:27:42.2746076+00:00",
"id2": 36,
"company_id": "2552b1c0-05ba-427d-8cf1-f3728ab194af",
"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": "fe302829-6055-4db1-8011-2c2705b21eae",
"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-07-24T07:27:42.2746076+00:00"
},
"work_instruction_details_id": "0f2283fe-6474-4514-8358-2feda1b0a672",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "63064411-3ae0-4a6e-854e-55362b3fc8c5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "da69d179-4cf6-4169-a183-0cf91e74a198",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-24T07:27:42.2746076+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": "9f6d1344-bde8-4786-a6cc-d0e3b15ea002",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-24T07:27:42.2746076+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.