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": "ac74c53b-51ce-4ed6-8e4a-7660169604ac",
"jobs_id": "170a204a-3550-4db7-9ded-c83ab64c5f3c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "97967c90-11ea-401f-9d83-d9841328daee",
"_parent_id": "0351a30a-aed6-4eb9-a9cd-42985a0568cc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fd8f8de5-939a-440e-a284-52b2bd8b7285",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dbe2e650-80a6-4b98-a6a0-cb8af3348556",
"_parent_id": "f9fda03e-1cc7-422c-a0bb-a6e2a98db95d",
"root_parent_id": "5e582353-0791-42da-9ca8-5bfbf8f139f1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e5a2e5fa-829e-433d-8a08-6a9a8a532f0c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7cf56702-df01-4652-bbdc-ca1994b1a859",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89b70a42-66b2-4d66-a1c2-db558362f504",
"_parent_code": "sample string 6",
"sales_organization_id": "bc1150bb-08d3-49aa-956d-c36dd2d10126",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
},
"equipment_model_id": "84f38785-4488-4be7-8b02-5372fb12e29d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0b11d453-f2fd-4f04-b8f0-9a0fddb02969",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f6e5b0d6-b0bf-4978-ae9d-f668abd96ca1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f1415ae5-5616-4ef4-ade6-0c1453787de5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ace88b8-4098-46fa-86fe-d8548e7bef4d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
},
"equipment_family_id": "59fa4fbb-cd08-490f-9046-462fb358625f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7cf56702-df01-4652-bbdc-ca1994b1a859",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "89b70a42-66b2-4d66-a1c2-db558362f504",
"_parent_code": "sample string 6",
"sales_organization_id": "bc1150bb-08d3-49aa-956d-c36dd2d10126",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
},
"date_in_production_since": "2026-09-23T15:21:40.032609+00:00",
"date_out_of_production_since": "2026-09-23T15:21:40.032609+00:00",
"date_end_support": "2026-09-23T15:21:40.032609+00:00",
"sales_organization_id": "7ba0f7e4-4943-455f-aab5-d2804cc1edd3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+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-23T15:21:40.032609+00:00"
},
"project_status_id": "92c25ac8-b79c-4427-8eb7-aff59d61f232",
"project_status_code": "sample string 10",
"project_status": {
"id": "c20ca5de-ccd2-4fbf-98f3-8a3e32cfce7c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "882b173d-53eb-440a-8784-05787426c483",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
},
"company_id": "25416aa7-9024-46e7-bf0c-b76a669dda94",
"company_code": "sample string 12",
"db_address_id": "bc5721c0-fef4-489a-9a7d-f26f6bde4c0e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aa5fd7fe-d26b-420e-b297-feb4fbd4415c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "585af9da-b67f-4c29-b1c0-42ad659df291",
"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-23T15:21:40.032609+00:00",
"date_create": "2026-09-23T15:21:40.032609+00:00",
"date_update": "2026-09-23T15:21:40.032609+00:00",
"updated_by_user_id": "d1fe82d1-92b0-4c4d-9e01-952c3ed2a5f5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T15:21:40.032609+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T15:21:40.032609+00:00",
"date_last_job": "2026-09-23T15:21:40.032609+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T15:21:40.032609+00:00",
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00",
"is_mobile_installation": true
},
"job_type_id": "f0c3c37e-28d6-4a5f-81e6-726b0ebf23d9",
"job_type_code": "sample string 7",
"job_type": {
"id": "6fd17035-deb9-49c2-91e6-e2b3b4942a5e",
"name": "sample string 2",
"sales_organization_id": "f239da39-3e52-457c-a512-f02aa90a18af",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00",
"code": "sample string 7"
},
"job_priority_id": "9f07b3fa-785c-45e4-85fb-917251ace670",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cde90529-8d83-4b36-b85b-4c3cd08844f5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "33723418-96dd-4a31-8ca7-72d316726676",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
},
"job_status_id": "17ae3761-721d-4e1a-b06a-3c764ee61de3",
"job_status_code": "sample string 11",
"db_address_id": "3ed4a186-61b4-435d-a674-d0b165d8da7d",
"contact_id": "ed3efbbd-f7c9-4e84-854e-38a25911a1e2",
"requested_by_company_id": "d028f93b-1816-42c0-8dcd-ca50f37c9e5b",
"requested_by_contact_id": "9abfb5ea-3fb2-4cce-81b6-3081deeacb0e",
"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-23T15:21:40.032609+00:00",
"due_date": "2026-09-23T15:21:40.032609+00:00",
"date_create": "2026-09-23T15:21:40.032609+00:00",
"date_update": "2026-09-23T15:21:40.032609+00:00",
"date_closed": "2026-09-23T15:21:40.032609+00:00",
"suggested_user_id": "cebea7fe-941f-4acd-b789-c07d63235841",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cba6ab41-d458-43ae-95c9-ee054d35bc50",
"db_language_id": "acaa95e8-809f-4e67-b02a-982bfd9f4a22",
"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-23T15:21:40.032609+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "58b79c74-0670-4ab1-b93c-b2c6706085ca",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "93fb14fa-0628-441d-afdb-0b32f76b4a8a",
"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": "1a1eb667-bea5-48a3-8fb4-50f8c9dae8d4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f8996e4d-20b0-497b-b247-9baa24770dd6"
},
"suggested_date_start": "2026-09-23T15:21:40.032609+00:00",
"skill_id": "8ea3d9ec-151f-4c81-b332-a55aeb467118",
"skill_code": "sample string 32",
"skill": {
"id": "ee2799c5-0d46-4cd7-9151-d3668c512101",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "00dde352-65da-4bb1-87cf-20dd9bd40c35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a9bfe383-e59e-4f81-8035-51b25af5f757",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "897d1c23-018a-4738-ae06-ab8517633146",
"db_currency_id": "c484c4ed-fb3a-49b5-8d2d-4841376bbd60",
"db_language_id": "01ca487e-b197-42bf-ac52-8fa48a39fbf5",
"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-23T15:21:40.032609+00:00"
},
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c908cb21-c0b1-4c4e-8fa8-de5684ea06dd",
"date_reported_by_company": "2026-09-23T15:21:40.032609+00:00",
"id2": 36,
"company_id": "3d677a68-5dde-47a6-9ff3-78f7315055db",
"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": "e7794bdf-a6f5-4806-852e-74cc136301a3",
"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-23T15:21:40.032609+00:00"
},
"work_instruction_details_id": "d606532e-9142-44a0-9c00-8f068922302d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e53f927b-cde2-4de9-a8da-b5037e86c425",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c021b784-009d-4347-9c66-a7af0459ab5d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T15:21:40.032609+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": "c41a57d6-eab5-48a1-9327-2d704415ec43",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T15:21:40.032609+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.