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": "f1855366-ee24-4058-8e8d-d03b758e4025",
"jobs_id": "1962edf3-323c-470a-9b46-1cb1b8a800ff",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e15d7dc4-ab64-4cb5-be06-4aa5195cfb12",
"_parent_id": "8633ec12-ce2c-4857-974b-2e9be4c994ec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e5ed70a9-9bde-4104-be4a-c8b804cb0065",
"project_reference_back_office": "sample string 5",
"project": {
"id": "532d9d08-15e7-4154-ad03-f684278410a5",
"_parent_id": "a4db6885-d5a5-4c6a-9c2b-d9bb2642c9dc",
"root_parent_id": "47a31930-7657-4a7e-b3e7-42c89c5e484b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a9ce443e-02c7-446b-a304-297012f30261",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f4b7c533-8aac-43a0-b406-03fbcde3801f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fffb049d-d202-4622-8250-24d7c609f936",
"_parent_code": "sample string 6",
"sales_organization_id": "aca2440e-99ea-40d0-b2c7-aceffd68c23a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
},
"equipment_model_id": "d7b1ac89-cda2-492d-830f-8c0be2b7faa7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c88753c8-de60-467c-b548-2b25a0222929",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2d6dc76f-9434-4da0-8285-838895724830",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b6161490-9dd1-4b10-baa1-7a5f79ea038e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f8025713-73d9-4cf7-a702-7fc865e2e0dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
},
"equipment_family_id": "0329f2d8-6a22-4b39-b3d5-e448351756ac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f4b7c533-8aac-43a0-b406-03fbcde3801f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fffb049d-d202-4622-8250-24d7c609f936",
"_parent_code": "sample string 6",
"sales_organization_id": "aca2440e-99ea-40d0-b2c7-aceffd68c23a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
},
"date_in_production_since": "2026-09-10T20:50:20.0430354+00:00",
"date_out_of_production_since": "2026-09-10T20:50:20.0430354+00:00",
"date_end_support": "2026-09-10T20:50:20.0430354+00:00",
"sales_organization_id": "2404b244-c3b5-468a-9bbf-c60e3851f79c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+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-09-10T20:50:20.0430354+00:00"
},
"project_status_id": "373806f3-b59b-42d4-8bad-ca9634504aaa",
"project_status_code": "sample string 10",
"project_status": {
"id": "7916ec7d-10d0-4f4e-abe9-b97cd3ab8afa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2d7e5fc6-3323-47a5-9af2-555bcbf3f50a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
},
"company_id": "e8b0cab2-cf01-49e2-af35-34c8df8ca952",
"company_code": "sample string 12",
"db_address_id": "3568a446-b147-4a7a-b650-cc1df991aec6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fed3b5b8-7e78-47d4-9c5d-fa353b974d67",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b0753f4f-ed68-4db1-82a3-4ad583e20155",
"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-09-10T20:50:20.0430354+00:00",
"date_create": "2026-09-10T20:50:20.0430354+00:00",
"date_update": "2026-09-10T20:50:20.0430354+00:00",
"updated_by_user_id": "5b3aeddb-fdeb-4e87-a539-7237b65a0315",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-10T20:50:20.0430354+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-09-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-10T20:50:20.0430354+00:00",
"date_last_job": "2026-09-10T20:50:20.0430354+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-10T20:50:20.0430354+00:00",
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00",
"is_mobile_installation": true
},
"job_type_id": "9daf1afc-bdf4-4a6d-8b96-822d3b7e3605",
"job_type_code": "sample string 7",
"job_type": {
"id": "7d264daf-e23c-4316-823b-876e18367e4a",
"name": "sample string 2",
"sales_organization_id": "37935415-08be-4787-b751-628f9e2f74ae",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00",
"code": "sample string 7"
},
"job_priority_id": "6071fc48-dee4-4e0e-a0cb-cf0fb54caab5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c0fe8b67-378c-4b9d-8fcf-302d81a826da",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3b247187-db53-41fd-9827-8c1c9b82a8ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
},
"job_status_id": "6253e47d-653d-4a51-acc7-bf683a55a687",
"job_status_code": "sample string 11",
"db_address_id": "75dd7c78-e136-46c9-ba1a-af448a528894",
"contact_id": "de0867e5-04e2-4a22-9a10-52c90913180c",
"requested_by_company_id": "18e9144c-5740-44f8-b73a-ab7da92c4d04",
"requested_by_contact_id": "8098e8dc-1925-47d1-893d-72d828e5f147",
"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-09-10T20:50:20.0430354+00:00",
"due_date": "2026-09-10T20:50:20.0430354+00:00",
"date_create": "2026-09-10T20:50:20.0430354+00:00",
"date_update": "2026-09-10T20:50:20.0430354+00:00",
"date_closed": "2026-09-10T20:50:20.0430354+00:00",
"suggested_user_id": "c0455441-32d3-4c01-8f03-40de32e7a693",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a756cfc1-27ec-487e-b0c0-f58d45f0546c",
"db_language_id": "af3086f9-6daa-4bd3-ac85-5d75545a6fcb",
"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-09-10T20:50:20.0430354+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "14ae1f33-df3f-4575-90d4-2d7d034414c5",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2439b286-7019-487c-b078-2efea23bf2f6",
"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": "00971e0c-e669-491a-9f59-d20d7a9af710",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "729307bb-81d6-450e-bf9e-a8f81c7ee5b9"
},
"suggested_date_start": "2026-09-10T20:50:20.0430354+00:00",
"skill_id": "95026a23-eca6-409b-bf5b-2dd82e639629",
"skill_code": "sample string 32",
"skill": {
"id": "439faea7-8bfd-41f9-b9a5-74fb319d70c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "07faa52d-6526-49b8-84be-7c6ec43626a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f65f2a2e-dae7-4886-b29f-a89e9b9b82e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25c9b842-cba5-4dce-a36f-9b39d99dde54",
"db_currency_id": "b7bc8650-b789-4a0b-b938-66454bb23960",
"db_language_id": "8b7f7c44-e595-4112-92ff-315b9a45563c",
"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-09-10T20:50:20.0430354+00:00"
},
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8ac652fb-43b3-42b2-be0f-ffffa4b68d5b",
"date_reported_by_company": "2026-09-10T20:50:20.0430354+00:00",
"id2": 36,
"company_id": "2f81a039-2a28-434b-b60d-1a37067afe47",
"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": "095d08e5-1e03-4462-b8b5-bf4f3de7ea6d",
"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-09-10T20:50:20.0430354+00:00"
},
"work_instruction_details_id": "e83347b7-c368-4fc5-a2dc-5b67b46927a8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "83b7cdaa-689a-47a6-a485-e5f68c01a912",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "684e8de0-db1d-43d9-a6c5-f7ac062e7728",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-10T20:50:20.0430354+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": "b8971445-de2d-4588-994f-2f235ea8be13",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-10T20:50:20.0430354+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.