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": "8ac8acb1-61db-4c44-9d88-54977c71a9e9",
"jobs_id": "12c24aab-df17-4376-aa8b-77f663b91e70",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2ff4dcff-20fa-4a30-91ad-01bf1e13609c",
"_parent_id": "36f78e35-ca11-43ac-a3f1-ae396cab5afd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "29c33dfc-fba5-4426-93ba-312f5de873cc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8823b9fe-dd63-45ed-a313-3975d0d1d45e",
"_parent_id": "8cc209f0-8760-4152-b893-1d8707751327",
"root_parent_id": "fedfae3a-9a67-4fe0-b9cf-2096663ea9c3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c9e86e72-5098-4fa3-a78d-fc13e5da4e70",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5e59e6ba-d876-4dfb-bc55-e2157bf91166",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "00cd09bc-58b8-4d07-9273-ed3dcdee3019",
"_parent_code": "sample string 6",
"sales_organization_id": "3f052579-763b-4b86-87aa-fba5dbd0a42d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
},
"equipment_model_id": "a48e5800-7dc9-40a9-bce9-4536be7e9d5c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f7676c62-6dd2-471e-9c5e-da6c7ee3da3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8701d11e-92fa-43f3-9243-500a68e5f107",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9e6081f6-35bf-4795-a47f-773f3f50c156",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a9d45f0-f48b-43f2-b1a8-e894315c5b03",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
},
"equipment_family_id": "a45365ca-da32-474f-86af-c003e4c26730",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5e59e6ba-d876-4dfb-bc55-e2157bf91166",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "00cd09bc-58b8-4d07-9273-ed3dcdee3019",
"_parent_code": "sample string 6",
"sales_organization_id": "3f052579-763b-4b86-87aa-fba5dbd0a42d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
},
"date_in_production_since": "2026-06-10T15:26:17.3793969+00:00",
"date_out_of_production_since": "2026-06-10T15:26:17.3793969+00:00",
"date_end_support": "2026-06-10T15:26:17.3793969+00:00",
"sales_organization_id": "4271dad8-3153-46cd-87f5-7d57889a21e1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+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-06-10T15:26:17.3793969+00:00"
},
"project_status_id": "0c7f7d64-c7c8-4db3-8848-8c41b6c0dc16",
"project_status_code": "sample string 10",
"project_status": {
"id": "09ff1356-b407-4ba5-9888-f854d961ac11",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f3e94c5c-9294-4a2a-bed7-90217e19f24c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
},
"company_id": "8237e9a2-9df5-4d21-8d38-721826d2d47e",
"company_code": "sample string 12",
"db_address_id": "d0f95b7f-77ca-4a34-a7eb-88e800847c62",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc8b281b-35ba-4106-80b1-face1b76d851",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d60185b6-ca3a-428f-9037-10eed356080f",
"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-06-10T15:26:17.3793969+00:00",
"date_create": "2026-06-10T15:26:17.3793969+00:00",
"date_update": "2026-06-10T15:26:17.3793969+00:00",
"updated_by_user_id": "4c6336e9-47a7-4f92-9472-9ef1ea046b3f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-10T15:26:17.3793969+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-06-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-10T15:26:17.3793969+00:00",
"date_last_job": "2026-06-10T15:26:17.3793969+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-10T15:26:17.3793969+00:00",
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00",
"is_mobile_installation": true
},
"job_type_id": "66692185-5890-498d-983d-609c9e340571",
"job_type_code": "sample string 7",
"job_type": {
"id": "423284f5-d053-4bea-9836-55a5a783cf94",
"name": "sample string 2",
"sales_organization_id": "b48e807b-3244-4f98-990d-0811e17e5f19",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00",
"code": "sample string 7"
},
"job_priority_id": "078cbb09-3b4d-4f8f-b421-574dfb600871",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "526a20a7-2032-42b1-88be-b9401d7eeab8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "14e2f730-8d8c-4ff8-b79e-121ac68d49ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
},
"job_status_id": "54d39269-d84a-4797-9d2d-efcd957cf36f",
"job_status_code": "sample string 11",
"db_address_id": "8dfb25f2-6d75-44a7-b169-36ea687f1390",
"contact_id": "30308b68-70f6-4180-b2c2-b1fb3531c7b2",
"requested_by_company_id": "c63e5d45-aa78-4893-ba9d-e945f45411b3",
"requested_by_contact_id": "fd050179-e0ec-4edc-8ed4-daa05d156dab",
"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-06-10T15:26:17.3793969+00:00",
"due_date": "2026-06-10T15:26:17.3793969+00:00",
"date_create": "2026-06-10T15:26:17.3793969+00:00",
"date_update": "2026-06-10T15:26:17.3793969+00:00",
"date_closed": "2026-06-10T15:26:17.3793969+00:00",
"suggested_user_id": "9d6a27d4-c0d1-4213-8cbf-b4b23e1a3f2d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "636f58d4-0256-417e-b8f3-48cd690e48da",
"db_language_id": "76cbef81-9a26-48e2-942e-39ecdb4f96b2",
"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-06-10T15:26:17.3793969+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b251edeb-fe5a-442e-a5f3-e50a93c826c9",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d9802f26-27af-4e7c-b728-fd8f67e46513",
"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": "ca8bac10-4f2b-4800-a2a5-af4eaa75cce7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4ecc10a8-eb3f-4920-a266-2e162e94094d"
},
"suggested_date_start": "2026-06-10T15:26:17.3793969+00:00",
"skill_id": "c802a800-5f73-4e62-ae8b-4f7a152914c4",
"skill_code": "sample string 32",
"skill": {
"id": "0a756790-195b-4275-b2f8-9df9ed324959",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f879a10-186c-40cf-8c9f-8bbdc26ebadb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e7fc2704-cfed-4fd9-906c-49e773629b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76e6a268-f6cf-49e7-9516-1e6e4553f68a",
"db_currency_id": "b7a8e421-0004-44d6-98b7-340c9c012773",
"db_language_id": "0a3d1e0a-3d7c-4a25-9157-c178bf558748",
"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-06-10T15:26:17.3793969+00:00"
},
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a27a050e-a0f1-4e63-ab44-e17655c94b7c",
"date_reported_by_company": "2026-06-10T15:26:17.3793969+00:00",
"id2": 36,
"company_id": "35d30958-e2a8-488d-8ae0-3d042f8f2b27",
"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": "77bd5fee-b40f-40f5-9eab-43fe7bc34707",
"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-06-10T15:26:17.3793969+00:00"
},
"work_instruction_details_id": "492d2180-c09d-46ac-bc70-7b980088a041",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e29dbe9-d97c-44bc-bc57-4e416346afba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b1a1d92d-4f46-4626-8b9b-98b78320d149",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-10T15:26:17.3793969+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": "3b5682b5-5c8a-4efd-baa2-9bd08df19aec",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-10T15:26:17.3793969+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.