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": "c9c1190c-dce0-4ece-a173-72b289961e18",
"jobs_id": "18d89331-ac49-47f7-9b0d-a7fc4e34330d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7a1800cb-7fcd-41d7-a756-8276311c37bd",
"_parent_id": "b7a46c76-81bd-48fa-a25c-f3310ba5aa03",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "779e372c-a697-441e-af29-22339e0f4869",
"project_reference_back_office": "sample string 5",
"project": {
"id": "06945ad9-d252-4c4c-877b-94685feda71c",
"_parent_id": "a966cb94-5775-4fad-b759-8e66bac97555",
"root_parent_id": "9e26eb93-0a4d-4aba-81f0-b0fadaba19be",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "58b3a884-d822-4634-8b88-d4387632c138",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f6dd4432-77a7-46d2-9c2c-16844a7bd349",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d925980c-b716-4e18-98a2-240c4d7cd4d6",
"_parent_code": "sample string 6",
"sales_organization_id": "1c91998a-2f28-48d6-850e-cebb90410573",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
},
"equipment_model_id": "b577f50f-f26e-4011-8c1e-db5bc45309c7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "396db63d-4add-46bc-adf3-4de80a60cc82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "aaf9e376-1322-45f0-bcbc-765d671b417d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6d2530db-60f1-4bc1-81f5-540b1f3de908",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "143fecb8-d776-4450-ae4a-53e392f03a95",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
},
"equipment_family_id": "525710ae-623b-4361-b110-7b525dd14d59",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f6dd4432-77a7-46d2-9c2c-16844a7bd349",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d925980c-b716-4e18-98a2-240c4d7cd4d6",
"_parent_code": "sample string 6",
"sales_organization_id": "1c91998a-2f28-48d6-850e-cebb90410573",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
},
"date_in_production_since": "2026-05-02T06:21:39.0181415+00:00",
"date_out_of_production_since": "2026-05-02T06:21:39.0181415+00:00",
"date_end_support": "2026-05-02T06:21:39.0181415+00:00",
"sales_organization_id": "dbce70e4-e506-4e33-9bb2-c19264fe8b28",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+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-05-02T06:21:39.0181415+00:00"
},
"project_status_id": "8d884175-91b2-4b6a-8275-e2c31c431eba",
"project_status_code": "sample string 10",
"project_status": {
"id": "f555a6f7-71bc-4c3e-9c28-10887bb650c4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fd55c742-24f4-4ebb-acfa-86bc1e5fa5f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
},
"company_id": "2e12545a-3b4c-4d27-acdf-c25ce69b8362",
"company_code": "sample string 12",
"db_address_id": "48e94412-6796-452a-8317-6e676b03a6c9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e1ea9b67-2fcb-4ff9-ad12-da202ada5114",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "38522ea1-4af5-45c6-93b0-dcc88e96bc94",
"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-05-02T06:21:39.0181415+00:00",
"date_create": "2026-05-02T06:21:39.0181415+00:00",
"date_update": "2026-05-02T06:21:39.0181415+00:00",
"updated_by_user_id": "b432067b-00f1-4ae4-a4c5-fcf5531fdd5d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-02T06:21:39.0181415+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-05-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-02T06:21:39.0181415+00:00",
"date_last_job": "2026-05-02T06:21:39.0181415+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-02T06:21:39.0181415+00:00",
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ff861f0-7993-45ca-b566-77d845a1de62",
"job_type_code": "sample string 7",
"job_type": {
"id": "1e697815-1bf3-44d5-a25f-286607a4264b",
"name": "sample string 2",
"sales_organization_id": "5172cf57-8cd2-475f-8c9c-2e6f6158ba30",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00",
"code": "sample string 7"
},
"job_priority_id": "8ea37dfa-4586-4a58-8335-66d0838ebca6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aca2b663-6f64-4254-8835-308d413efa8e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "375dd46e-e712-4bf9-bb98-e23feeafbf86",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
},
"job_status_id": "02e418e4-1370-425b-8b04-c7857940b8d9",
"job_status_code": "sample string 11",
"db_address_id": "007d34b4-32cc-4685-9f3c-dd16eff75b85",
"contact_id": "48f33dbd-2e4e-40d3-9299-046b2ca7f00e",
"requested_by_company_id": "a94f9af9-a1bd-49e2-ba30-1d0e3b3af4a2",
"requested_by_contact_id": "62c6856a-1d15-4d0f-9520-be8ad04a6f19",
"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-05-02T06:21:39.0181415+00:00",
"due_date": "2026-05-02T06:21:39.0181415+00:00",
"date_create": "2026-05-02T06:21:39.0181415+00:00",
"date_update": "2026-05-02T06:21:39.0181415+00:00",
"date_closed": "2026-05-02T06:21:39.0181415+00:00",
"suggested_user_id": "9c34c9af-89ff-4675-ba48-02415abdb1f8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b1de6e9e-04e3-4983-b2b5-148f4b83f63a",
"db_language_id": "aca596e0-fda0-450f-add6-a4f66d029723",
"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-05-02T06:21:39.0181415+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9702b63-f400-4e86-9db8-322f61806f54",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "41a12554-8821-4210-b81a-65494e713c18",
"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": "45e89ee4-3653-4f14-a82b-b8394a81527e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "39e1e6d2-e17c-4524-8e5b-ad3ddfcdb275"
},
"suggested_date_start": "2026-05-02T06:21:39.0181415+00:00",
"skill_id": "0fba91ad-2754-4245-80bd-460115830fe1",
"skill_code": "sample string 32",
"skill": {
"id": "a4397e6b-8938-4c04-9d47-7a701228c406",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "63f7a16a-257b-472a-8be6-1720bdb71b81",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c5deb35-b80f-442d-a3f0-27be6826a3e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c303266-ab47-41c2-ad8c-7db1e4e6a8e9",
"db_currency_id": "dea77716-a75c-4d89-8866-53f6a241beed",
"db_language_id": "e283976d-b889-4cbd-847f-4a23a5925bd3",
"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-05-02T06:21:39.0181415+00:00"
},
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9046f348-1de9-4f74-bf88-b1409c99d099",
"date_reported_by_company": "2026-05-02T06:21:39.0181415+00:00",
"id2": 36,
"company_id": "e754ac88-7ec7-48f7-9119-18cf53d5f6b2",
"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": "974b0a98-dd2c-4eee-b417-026595261926",
"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-05-02T06:21:39.0181415+00:00"
},
"work_instruction_details_id": "f32ab659-eeb2-49fb-9a69-1af3db1977df",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c246619d-bea9-4927-97c3-191677d6fdba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a7f4ef85-0acc-4264-87be-7d34179f08e8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-02T06:21:39.0181415+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": "ade4f476-7518-416d-aba0-09ad885a8505",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-02T06:21:39.0181415+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.