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": "c6cd0511-2f3e-4922-b73d-0b23430a67a8",
"jobs_id": "2ccf0abc-8abd-4022-a9cf-58b0e0a94d47",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "425fcafa-7ace-490b-8822-85ea365eccb9",
"_parent_id": "de2b4c81-1e2d-47c0-bc0c-6e8732a5b872",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4ac0c563-189d-4bb3-ace9-1ad1813dc794",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a01611e7-4075-459c-952e-5997376a3e9a",
"_parent_id": "0edc382c-7000-47cb-8b43-80e6185f70e8",
"root_parent_id": "7def6adf-f106-4911-a260-1d8dff7531f3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9af8c88f-a9b9-4513-9b82-43c693f7c234",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "29af6bb1-8726-4771-aaa1-24d0311b3a6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abd349c8-4af2-44e7-a5b3-473670b0b4a9",
"_parent_code": "sample string 6",
"sales_organization_id": "f884e5cc-653c-40e5-88ec-6195c47615fe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"modified_dateutc": "2026-10-23T08:12:41.8042379+00:00"
},
"equipment_model_id": "8328b744-5635-461b-be6f-115583012ed3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d90347a-d8e6-4831-a496-e5315411947f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "39487890-a33e-43d5-9863-59cc1b715506",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "21667fef-4522-44e9-bbcb-6364dc01a704",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a5b2fece-87dd-45f2-a67c-8181a2782792",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"modified_dateutc": "2026-10-23T08:12:41.8042379+00:00"
},
"equipment_family_id": "82619b6a-474f-4215-a8d4-e14e3bb2a8f7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "29af6bb1-8726-4771-aaa1-24d0311b3a6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abd349c8-4af2-44e7-a5b3-473670b0b4a9",
"_parent_code": "sample string 6",
"sales_organization_id": "f884e5cc-653c-40e5-88ec-6195c47615fe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"modified_dateutc": "2026-10-23T08:12:41.8042379+00:00"
},
"date_in_production_since": "2026-10-23T08:12:41.8042379+00:00",
"date_out_of_production_since": "2026-10-23T08:12:41.820441+00:00",
"date_end_support": "2026-10-23T08:12:41.820441+00:00",
"sales_organization_id": "0c039495-79a2-45e2-8444-01f132260e8b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+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-10-23T08:12:41.820441+00:00"
},
"project_status_id": "05aefec2-c65b-4b9f-81f6-67b2dd8f357f",
"project_status_code": "sample string 10",
"project_status": {
"id": "16c56951-6f24-4120-820a-0a03bf5835a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "510b06d4-ccc5-4372-a435-5a001c662322",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T08:12:41.820441+00:00"
},
"company_id": "4d65c8f3-84df-4489-8e42-cbd9d1194f22",
"company_code": "sample string 12",
"db_address_id": "c2e0961f-2aaf-41a2-95c0-5e97f90c54c2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1caad991-b24c-42f8-8831-b9b45a725a0f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4bf50aec-d00c-41b6-a4e6-e4e421986546",
"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-10-23T08:12:41.820441+00:00",
"date_create": "2026-10-23T08:12:41.820441+00:00",
"date_update": "2026-10-23T08:12:41.820441+00:00",
"updated_by_user_id": "e4609a91-6f21-4bdf-bc21-1d967baf6e28",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-23T08:12:41.820441+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-10-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-23T08:12:41.820441+00:00",
"date_last_job": "2026-10-23T08:12:41.820441+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-23T08:12:41.820441+00:00",
"modified_dateutc": "2026-10-23T08:12:41.820441+00:00",
"is_mobile_installation": true
},
"job_type_id": "7686401a-efa7-4433-81b3-6ba9bcab67b1",
"job_type_code": "sample string 7",
"job_type": {
"id": "136e01b0-0aae-41dc-b6a2-7321d587859e",
"name": "sample string 2",
"sales_organization_id": "2af468ac-810e-49fc-9d5f-54eeb593f3c1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-23T08:12:41.820441+00:00",
"code": "sample string 7"
},
"job_priority_id": "a315710b-8a66-499f-88c1-078d9c549609",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "56e2a501-1618-4216-b141-d5bbfdc1634a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "74f20d58-c20b-4908-9646-466320e7049b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T08:12:41.820441+00:00"
},
"job_status_id": "f9bbc475-dfb4-4572-b161-d195abb3ef4c",
"job_status_code": "sample string 11",
"db_address_id": "87962918-acfc-469b-9a66-52775dd9d154",
"contact_id": "17d6256b-d92e-414b-b2b8-7e6caa3e89bd",
"requested_by_company_id": "99adb1cb-207b-403b-8a9f-ccd07cf0554b",
"requested_by_contact_id": "af62e3c2-d090-444f-851e-4cce6e1bcc0b",
"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-10-23T08:12:41.820441+00:00",
"due_date": "2026-10-23T08:12:41.820441+00:00",
"date_create": "2026-10-23T08:12:41.820441+00:00",
"date_update": "2026-10-23T08:12:41.820441+00:00",
"date_closed": "2026-10-23T08:12:41.820441+00:00",
"suggested_user_id": "968d21a3-3478-4bbf-834d-39a20539a69a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f551b7d0-ce92-4de9-8696-135678f121f3",
"db_language_id": "c05b456f-6d6c-43c9-b36d-7df579e5939d",
"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-10-23T08:12:41.8402471+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5e0ed449-f882-4f8f-8de6-9061c75d97da",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "11002b87-7348-4458-bd1e-a6e63e734d6f",
"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": "72810233-f508-4732-b6cb-43d3367c7396",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-23T08:12:41.8402471+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "551d84df-38db-47e9-b2b8-6dd8956e9c5d"
},
"suggested_date_start": "2026-10-23T08:12:41.8402471+00:00",
"skill_id": "17bbb434-6120-40aa-b79e-d7588a27e183",
"skill_code": "sample string 32",
"skill": {
"id": "2fcc1a08-ba85-4c64-abfe-898df935797d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9bcc70b4-0bae-4cdc-b9c5-3404deb015cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7bf9675-7bf2-46b4-8e58-cef0953fbc1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8edd32d1-c196-4817-bf64-543647cbb9b1",
"db_currency_id": "5cf175c9-45b9-4c7f-8b9a-bd255b849cba",
"db_language_id": "904c6946-4b4c-432c-be17-9c11995f8537",
"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-10-23T08:12:41.8042379+00:00"
},
"modified_dateutc": "2026-10-23T08:12:41.8402471+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6c8e2f0e-838d-4bc5-a4ba-5a4504fb89e6",
"date_reported_by_company": "2026-10-23T08:12:41.8402471+00:00",
"id2": 36,
"company_id": "4aca78f6-02df-44b4-8ab8-9767ded51609",
"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": "5b9a4f9c-4759-4ece-b38c-790d3d3cf7e4",
"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-10-23T08:12:41.8402471+00:00"
},
"work_instruction_details_id": "d37a46ce-7344-40eb-bf27-714afe0af0ca",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "84746cb5-9468-468a-b399-749282e809a7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aa48070a-6b44-430f-856e-1468290168e9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-23T08:12:41.8402471+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": "a81b0d5e-0032-4e68-aa0e-28af96af436b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-23T08:12:41.8402471+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.