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": "0c80f9c2-1a7b-4035-8533-bb414da9ab28",
"jobs_id": "fa3cb2f4-cb0e-4735-a45d-ada5f1a404d3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b35618c8-9948-4072-8370-28ce17744f78",
"_parent_id": "25e92aaa-7a8d-4e5c-94e0-84c3dc556086",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5a991e51-952f-4f49-a6ab-df3a3888cb3b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "44d14631-d7bd-4562-a712-5ae11b763be6",
"_parent_id": "8408e8fd-5ed1-44af-8784-55290dd15cd3",
"root_parent_id": "a4b108da-64d5-4604-81c4-6961737bc5be",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6950b2bd-b32a-478c-8291-ae98e7d24fd9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23b3c4ca-7a44-46c3-93f1-611723c99f0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "462d6ec2-eb97-4dd7-8c27-19f831021053",
"_parent_code": "sample string 6",
"sales_organization_id": "cea2fc32-b5af-4e94-afb3-ce39be96cde1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"modified_dateutc": "2025-11-21T23:26:31.5796552+00:00"
},
"equipment_model_id": "8746fde0-10d2-4e57-b406-729706e3a603",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e204f51f-8a58-4906-897f-4d12bd15d1f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "09ac2aba-b32e-496e-b360-14a9aa117763",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f88480f5-1549-4597-825d-0ce34c9e4249",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1ac151ec-1cbb-48cf-bd34-46f79e81b9dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"modified_dateutc": "2025-11-21T23:26:31.5796552+00:00"
},
"equipment_family_id": "5e4e262b-7a52-40cd-abef-5299521f01cd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23b3c4ca-7a44-46c3-93f1-611723c99f0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "462d6ec2-eb97-4dd7-8c27-19f831021053",
"_parent_code": "sample string 6",
"sales_organization_id": "cea2fc32-b5af-4e94-afb3-ce39be96cde1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"modified_dateutc": "2025-11-21T23:26:31.5796552+00:00"
},
"date_in_production_since": "2025-11-21T23:26:31.5796552+00:00",
"date_out_of_production_since": "2025-11-21T23:26:31.5796552+00:00",
"date_end_support": "2025-11-21T23:26:31.5796552+00:00",
"sales_organization_id": "4d25646e-2771-45ac-ad8f-ef94b4033c84",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+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-11-21T23:26:31.5796552+00:00"
},
"project_status_id": "db7c27eb-c4f6-460a-b62b-1226c7f7b249",
"project_status_code": "sample string 10",
"project_status": {
"id": "be02aafe-724c-4273-b5f5-01ae463dfcea",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b0777f2c-2087-4663-a50c-81a70d73266f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T23:26:31.5796552+00:00"
},
"company_id": "58440eac-05d9-4cea-8267-8b3e0f63b72e",
"company_code": "sample string 12",
"db_address_id": "669c56a0-aadf-480c-9463-8fdafd488c93",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "95fe707c-4a52-4f11-9933-d740d49a59ce",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8e701986-a1cc-4460-8466-85a7be20115d",
"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-11-21T23:26:31.5796552+00:00",
"date_create": "2025-11-21T23:26:31.5796552+00:00",
"date_update": "2025-11-21T23:26:31.5796552+00:00",
"updated_by_user_id": "bc4a10c9-b02f-4f83-825b-71a5e842d186",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-21T23:26:31.5796552+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-21T23:26:31.5796552+00:00",
"date_last_job": "2025-11-21T23:26:31.5796552+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-21T23:26:31.5796552+00:00",
"modified_dateutc": "2025-11-21T23:26:31.5796552+00:00",
"is_mobile_installation": true
},
"job_type_id": "8a7030d1-a816-4913-b603-e5b81570745c",
"job_type_code": "sample string 7",
"job_type": {
"id": "2efabf5e-716f-44b7-ac25-e4eac663ecf1",
"name": "sample string 2",
"sales_organization_id": "113d64ac-5072-4ed9-b4cf-07abbabd6603",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-21T23:26:31.5796552+00:00",
"code": "sample string 7"
},
"job_priority_id": "117bf660-5e35-4a3c-9159-a1f9975fee28",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "05c3ce56-fa58-48a2-94b7-84b2c2507027",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "88fedd66-fc63-4319-85f5-b3d62a8472ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T23:26:31.5952787+00:00"
},
"job_status_id": "9d2be57c-9fbd-49a2-a716-e578be6c0adb",
"job_status_code": "sample string 11",
"db_address_id": "9cdcbc81-23d5-4999-87aa-7e79ac056bb3",
"contact_id": "990ca842-fe4f-4556-af4e-176d457db6c5",
"requested_by_company_id": "72ce12af-ebad-4abb-9312-caae3b174440",
"requested_by_contact_id": "f8d845ee-bfe1-4f7b-acef-882833454a14",
"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-11-21T23:26:31.5952787+00:00",
"due_date": "2025-11-21T23:26:31.5952787+00:00",
"date_create": "2025-11-21T23:26:31.5952787+00:00",
"date_update": "2025-11-21T23:26:31.5952787+00:00",
"date_closed": "2025-11-21T23:26:31.5952787+00:00",
"suggested_user_id": "45eb0d36-7587-48f7-a398-65d7ff0bd73e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8e7f7c65-07ea-4112-80eb-3a1b8dd675e0",
"db_language_id": "55bb5d04-0110-4018-bad6-d403c0f06071",
"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-11-21T23:26:31.5952787+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1c9f84eb-09cb-4cc9-8864-40d9732a7efd",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3337ab5e-bc6d-400f-ac9e-17b230dcc8b7",
"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": "24a88af2-9297-491d-a59c-1948801f2280",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-21T23:26:31.5952787+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ad9b0461-b278-45dd-ba9c-4a9589088406"
},
"suggested_date_start": "2025-11-21T23:26:31.5952787+00:00",
"skill_id": "568181cb-c601-4bed-9c0f-3300a837054e",
"skill_code": "sample string 32",
"skill": {
"id": "74e7d458-19f4-47cf-8692-85d0b82f7a7e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f14bbd4e-aace-45d4-aece-9f8818c2dc10",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dcbcf242-e1fe-493c-9e94-3d53403e61fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93e4fff6-b3aa-40d5-828e-be21830f8e7a",
"db_currency_id": "d4bb83ea-b3c3-45c8-91e4-9f69661c4279",
"db_language_id": "88c93f1e-a2cd-4f8a-a640-1061af00e1f4",
"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-11-21T23:26:31.5796552+00:00"
},
"modified_dateutc": "2025-11-21T23:26:31.5952787+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "44016ffe-9ef5-446d-84db-b9b8c74bee23",
"date_reported_by_company": "2025-11-21T23:26:31.5952787+00:00",
"id2": 36,
"company_id": "12add4bb-0528-4b47-bc23-dc0de552cabb",
"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": "910e2df3-e700-4932-beca-8a57a12063da",
"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-11-21T23:26:31.5952787+00:00"
},
"work_instruction_details_id": "38f9d61b-c779-4ec9-a642-c2129de0ba55",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "01637227-1ca6-4e82-a673-c597dadb4329",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b20c2536-da57-419f-ba01-c744785f8263",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-21T23:26:31.5952787+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": "4b807084-b0f2-454f-8692-c62ca59d80bc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-21T23:26:31.5952787+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.