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": "86505b4e-8166-4ab7-9025-5f18f3b8465f",
"jobs_id": "4d8f3a6d-9433-4295-bde8-f2ede5a7d4f1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9abf6a38-590b-4875-82f7-47e00855f940",
"_parent_id": "1a0307b9-af95-4f52-9a74-d5bd440d19db",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5b885655-368f-41e1-801d-5db65242d9e9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4233767a-cdc7-4ca4-b02c-adaf14bba00b",
"_parent_id": "a002925e-ddbd-4404-878c-a80e98db85a6",
"root_parent_id": "039bce92-7192-4b71-a546-45e82258cfc2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "269f17c7-37ea-4782-995e-b7b679bd0bef",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e0bcddc0-62eb-49c3-81cf-c819cd9cfbdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5293ed9-693e-49d1-8032-35615e33786e",
"_parent_code": "sample string 6",
"sales_organization_id": "baf4a491-a086-4600-bf95-9d8925075be2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
},
"equipment_model_id": "2e37ae98-67ed-480b-b14e-8cde4631d98d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b2486fc6-99c0-46d4-b895-9db60a2809a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "21abf508-9121-4b5f-95b1-9acfc00cfe54",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "058103c9-67b5-444a-b26b-7ff31270d600",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "db631c03-9a15-421c-af6b-a8d28864d495",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
},
"equipment_family_id": "91a9a4be-82cf-4846-978b-8c0c5910ad50",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e0bcddc0-62eb-49c3-81cf-c819cd9cfbdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5293ed9-693e-49d1-8032-35615e33786e",
"_parent_code": "sample string 6",
"sales_organization_id": "baf4a491-a086-4600-bf95-9d8925075be2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
},
"date_in_production_since": "2026-07-30T04:32:42.1812819+00:00",
"date_out_of_production_since": "2026-07-30T04:32:42.1812819+00:00",
"date_end_support": "2026-07-30T04:32:42.1812819+00:00",
"sales_organization_id": "12db54cb-7a82-44bd-af52-c762b18324df",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+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-07-30T04:32:42.1812819+00:00"
},
"project_status_id": "c2bfbddb-4d83-430f-8182-2ea148fb5cb3",
"project_status_code": "sample string 10",
"project_status": {
"id": "61d8967a-1567-4c2d-87d8-cbfb8bed22e9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ded812b4-b28d-446a-89eb-cd8f3f61d65e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
},
"company_id": "70e4333f-7bd5-46d1-91b2-9814ce54b567",
"company_code": "sample string 12",
"db_address_id": "0640e393-f702-46cd-b04d-0a1d7171a750",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "91d6199e-c953-4f72-b2d9-63c8ec2951f4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b84e1170-a8e5-4ab3-98f1-c68ac478484f",
"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-07-30T04:32:42.1812819+00:00",
"date_create": "2026-07-30T04:32:42.1812819+00:00",
"date_update": "2026-07-30T04:32:42.1812819+00:00",
"updated_by_user_id": "d0c7a29b-00e1-482d-b51c-2bc35dd24812",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-30T04:32:42.1812819+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-07-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-30T04:32:42.1812819+00:00",
"date_last_job": "2026-07-30T04:32:42.1812819+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-30T04:32:42.1812819+00:00",
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00",
"is_mobile_installation": true
},
"job_type_id": "d0b86550-2cc8-462b-83f8-5d397a39d72a",
"job_type_code": "sample string 7",
"job_type": {
"id": "4a2d9979-6889-484b-99df-fcac43238e9d",
"name": "sample string 2",
"sales_organization_id": "a6caed70-b16f-4cbc-98eb-2d9d0936cfa6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00",
"code": "sample string 7"
},
"job_priority_id": "94656064-ee52-4367-a284-1b0ae4523d7c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f7a99746-8a4b-4eb8-9dbe-9b7cd24d430d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ade5e9d-48d4-48f5-89dd-4aaf834895da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
},
"job_status_id": "f873c1ea-6b5c-43c8-989e-4f9b2d7f3610",
"job_status_code": "sample string 11",
"db_address_id": "ca188ffa-7d8a-482c-a683-ab6ac5be30a8",
"contact_id": "3f535c9d-15b8-4b33-9bfe-27533c85fb90",
"requested_by_company_id": "ab398f6a-1ae7-496f-ac0e-82909e9fe684",
"requested_by_contact_id": "b23e6354-d260-4d5a-9050-bcfb1588de20",
"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-07-30T04:32:42.1812819+00:00",
"due_date": "2026-07-30T04:32:42.1812819+00:00",
"date_create": "2026-07-30T04:32:42.1812819+00:00",
"date_update": "2026-07-30T04:32:42.1812819+00:00",
"date_closed": "2026-07-30T04:32:42.1812819+00:00",
"suggested_user_id": "63a99501-12a4-4c15-b7e9-041f322e624b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d4421258-8228-4a8d-a069-2fa6cf95e2f7",
"db_language_id": "56d179e8-e951-4075-b2c7-65e7a0a5cb5f",
"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-07-30T04:32:42.1812819+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c71f13b1-e2c8-4acf-add4-e14f83d8a8ac",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73aa1bc0-250e-400c-8b3d-f267382765bb",
"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": "eb805785-5e9c-4bfd-8ceb-b1dd3137399d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "46471243-e442-466a-9f9f-84bacc457da4"
},
"suggested_date_start": "2026-07-30T04:32:42.1812819+00:00",
"skill_id": "50e8f3dd-43df-42ca-91a9-fab5f716d2d2",
"skill_code": "sample string 32",
"skill": {
"id": "38928816-92f3-4d40-bad1-39ec012fc270",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a134f86e-70f1-45c5-9f7d-96ca89cede3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff0e9d10-fd82-497c-b626-4bd94142a4cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2156bd5-97da-4988-b64e-fbaae0de209d",
"db_currency_id": "11f2af4d-29eb-4291-a273-999618ddcb58",
"db_language_id": "b36fc682-9398-45ff-a50e-54fac23eb67a",
"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-07-30T04:32:42.1812819+00:00"
},
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "611cc2a8-3048-42c5-a56b-d80bcc556933",
"date_reported_by_company": "2026-07-30T04:32:42.1812819+00:00",
"id2": 36,
"company_id": "bbb9e115-175e-4202-9283-a56b882ae85f",
"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": "45658cb7-8e59-4c0a-83ad-3005fd1d58cd",
"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-07-30T04:32:42.1812819+00:00"
},
"work_instruction_details_id": "f5eae29f-dd8f-4880-bbd1-36ec88c79eb1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "93ebaa92-c151-4ff8-8564-083ad0311bbb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8276274a-0257-40d1-8c59-201369f8cf1f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-30T04:32:42.1812819+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": "dd2d4809-1d2d-4877-a94f-a3581e25c05b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-30T04:32:42.1812819+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.