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": "cfd56589-eb3c-42f2-9cb1-c1380fb45293",
"jobs_id": "8c62cc2d-af39-4643-bef3-8041421c413c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3807c274-03b4-4e63-ad5b-317b5676da57",
"_parent_id": "358323ee-d2e3-47f1-98ff-5e3a9e9cf498",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4400f6f6-e0e2-4176-837a-afed5aae912c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77767d0e-108d-4826-b3e2-6df70a1cfd55",
"_parent_id": "48928dd8-4912-425d-bfaf-fdfee852ae75",
"root_parent_id": "73ea441d-dda0-46e4-9351-7f86b22352b3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "326a84d5-433d-431d-b130-46c38277dc70",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f2a687e4-d42f-4bec-9ec2-08d128d67b14",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89e23c6d-1de0-4221-8a1c-d28cc39282dd",
"_parent_code": "sample string 6",
"sales_organization_id": "7c83244c-0c1f-4155-9c89-a188262f1a35",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
},
"equipment_model_id": "76f8efb0-16d6-404a-aa31-9684ff3e50c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "17fa66d6-9736-4cbd-91ce-6b1fb742f673",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9414ae6f-70d2-4a18-b2b3-a753c5aa34c3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "92b46172-b070-43d7-b9b9-d89531f0c796",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7fe5e69f-5481-40e5-9112-ffc26ba168c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
},
"equipment_family_id": "97c71953-948b-4f89-ae7a-e3333c1c6585",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f2a687e4-d42f-4bec-9ec2-08d128d67b14",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89e23c6d-1de0-4221-8a1c-d28cc39282dd",
"_parent_code": "sample string 6",
"sales_organization_id": "7c83244c-0c1f-4155-9c89-a188262f1a35",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
},
"date_in_production_since": "2025-09-12T07:37:05.2712561+00:00",
"date_out_of_production_since": "2025-09-12T07:37:05.2712561+00:00",
"date_end_support": "2025-09-12T07:37:05.2712561+00:00",
"sales_organization_id": "d547f6b4-1ff8-4e65-b843-9a23fce6a38c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+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-09-12T07:37:05.2712561+00:00"
},
"project_status_id": "bc6805b6-8088-46e2-acd7-ba55f4bfaaec",
"project_status_code": "sample string 10",
"project_status": {
"id": "325e461e-57b8-445e-964d-7d8973a8a4cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1d2175f3-cb9e-4f52-a7f9-27bc6ed8ab88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
},
"company_id": "496e093c-5f79-4d37-882b-66670dc8c464",
"company_code": "sample string 12",
"db_address_id": "46f4a25d-6f29-4400-91cc-3ccce8533093",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e702a547-bea5-4c5e-9db7-a60f517319cc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7d15d3d4-2a42-4275-9ac9-1038e52ecca8",
"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-09-12T07:37:05.2712561+00:00",
"date_create": "2025-09-12T07:37:05.2712561+00:00",
"date_update": "2025-09-12T07:37:05.2712561+00:00",
"updated_by_user_id": "dc3af30e-7ac9-408e-9d00-ec61fdad7f1b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-12T07:37:05.2712561+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-09-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-12T07:37:05.2712561+00:00",
"date_last_job": "2025-09-12T07:37:05.2712561+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-12T07:37:05.2712561+00:00",
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00",
"is_mobile_installation": true
},
"job_type_id": "b8aa74c1-93cd-4dd4-b0f5-33123461a87d",
"job_type_code": "sample string 7",
"job_type": {
"id": "32a4bef2-1a01-41cb-b810-1e4522417fb5",
"name": "sample string 2",
"sales_organization_id": "c6d0a514-9370-4f45-83a6-2a5c2a2e672d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00",
"code": "sample string 7"
},
"job_priority_id": "0a8e7fc2-54cf-4848-97ad-3f12a469ee95",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4be1e06b-f6fe-484b-9b7b-ca0b9025650b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "269fcfbf-3729-408f-a234-b0611951d880",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
},
"job_status_id": "704c8993-7706-4028-9d87-cb19776a2370",
"job_status_code": "sample string 11",
"db_address_id": "6f371e06-148b-4f25-a383-5f05126e4994",
"contact_id": "7c889773-afe5-4dfa-b498-f3f5a3617f0b",
"requested_by_company_id": "e5f70c1e-764d-4732-83d0-b3c60cd2b4f3",
"requested_by_contact_id": "f2090048-9ab5-4932-8dda-ceb2f38891fe",
"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-09-12T07:37:05.2712561+00:00",
"due_date": "2025-09-12T07:37:05.2712561+00:00",
"date_create": "2025-09-12T07:37:05.2712561+00:00",
"date_update": "2025-09-12T07:37:05.2712561+00:00",
"date_closed": "2025-09-12T07:37:05.2712561+00:00",
"suggested_user_id": "0128d7c3-1b8d-4471-8338-7ea9712713bd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "15de83b7-d90b-42c9-81eb-33abc475372d",
"db_language_id": "2716166b-a6b2-4176-a072-396a5162002b",
"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-09-12T07:37:05.2712561+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3c48acd9-06e3-4371-bcb9-61914be58a8f",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ca6cb9df-d6b0-49d0-9b05-10636d5faa3b",
"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": "7ca766ad-005f-41c7-b54e-83592687c02d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a652ce19-211f-46cd-a1f4-7b01005bef6d"
},
"suggested_date_start": "2025-09-12T07:37:05.2712561+00:00",
"skill_id": "8615fe94-4fb2-4f34-877a-dbb7f1ce218d",
"skill_code": "sample string 32",
"skill": {
"id": "4c07ed8b-9c88-4bb9-a068-4c6ce5573ce3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b2f07664-4ae9-4f16-ace6-0719da64a59f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "30e9a39b-01e4-454b-98d9-807717e5efb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23737292-5bdd-4fb4-b30c-9067441e7460",
"db_currency_id": "e2f2b99a-a1e3-46a9-af6a-1d2e08acce92",
"db_language_id": "50bc0185-c517-4930-bc1c-013dc6e9b13e",
"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-09-12T07:37:05.2712561+00:00"
},
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6b9f4434-f477-4a23-bd80-5ec6a9ae733a",
"date_reported_by_company": "2025-09-12T07:37:05.2712561+00:00",
"id2": 36,
"company_id": "91bb38d1-c91f-40a3-9ad7-990df0d071c4",
"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": "ca893710-4f4a-407e-8ba2-b4a90ad8538b",
"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-09-12T07:37:05.2712561+00:00"
},
"work_instruction_details_id": "0c77f43c-b603-4cd6-8626-274614bb3870",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5f8b08cc-78f0-4cd1-a458-76e8ec20a367",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "68a4a00a-3e1c-440a-8c3b-3bd6e1e6ac87",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-12T07:37:05.2712561+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": "16944fed-5bc6-4c11-8ef9-e3c014e363b0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-12T07:37:05.2712561+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.