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": "c464409e-04bd-4d37-ac7c-1eddd0e90b7c",
"jobs_id": "274bd4fc-07e2-47cb-903f-b4b2d311224c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "512da16f-7171-45b4-9380-82aab858b42c",
"_parent_id": "26f5b89b-38de-4704-9af9-13b98f9bff51",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "61496d39-2e1a-4799-9dca-7b04f20b30a1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7d74823b-fbb4-4938-a2f4-44a02676e635",
"_parent_id": "3b3b36b7-a152-4f25-8fee-7abb22cb4559",
"root_parent_id": "79afc79d-e440-47c3-8970-eee6571e170c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "31c394c3-6828-42bb-b4c2-adb77d3732a6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8397c5dd-8d2b-439e-8c9f-4eda271be882",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e0078a7-6c53-407e-a11c-f32a1b386081",
"_parent_code": "sample string 6",
"sales_organization_id": "7593f677-cb02-4a6e-b801-417fe822a7e7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
},
"equipment_model_id": "f13f0699-1f09-4e19-9800-0345886a97fa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b5958054-8d2c-4af6-96fe-3bdf6dbe14e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bc29bdd3-af99-428d-9692-ceaef960b7e4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "de8a37de-64c9-4bbf-9500-6a72253d4480",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "98d50512-8f8c-48b5-bd9b-9de62938df03",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
},
"equipment_family_id": "18e0dbef-1ff0-4639-9006-5a458e291496",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8397c5dd-8d2b-439e-8c9f-4eda271be882",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e0078a7-6c53-407e-a11c-f32a1b386081",
"_parent_code": "sample string 6",
"sales_organization_id": "7593f677-cb02-4a6e-b801-417fe822a7e7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
},
"date_in_production_since": "2026-05-30T01:01:49.8640555+00:00",
"date_out_of_production_since": "2026-05-30T01:01:49.8640555+00:00",
"date_end_support": "2026-05-30T01:01:49.8640555+00:00",
"sales_organization_id": "bf8b1ffb-2ac6-47ce-a725-746e0aca2835",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+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-05-30T01:01:49.8640555+00:00"
},
"project_status_id": "33a8c99c-c34d-47ac-8aa7-f74443fac1de",
"project_status_code": "sample string 10",
"project_status": {
"id": "fd6d286b-786c-4e53-b910-647309443520",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "acff7cb9-c7c2-49f4-8b11-0f25445cacd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
},
"company_id": "19d6cb09-9e17-4606-95e6-8c070940ebdb",
"company_code": "sample string 12",
"db_address_id": "08c80d94-20ec-4b82-8253-c91f3d913c87",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "49da506c-9a39-4069-a5da-0082a6c3dcf4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fde91b27-36cf-4aa5-a989-e169b3e79c30",
"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-05-30T01:01:49.8640555+00:00",
"date_create": "2026-05-30T01:01:49.8640555+00:00",
"date_update": "2026-05-30T01:01:49.8640555+00:00",
"updated_by_user_id": "00eeeeeb-cb4e-4e05-bad9-f4ac1f84132a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T01:01:49.8640555+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-05-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T01:01:49.8640555+00:00",
"date_last_job": "2026-05-30T01:01:49.8640555+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T01:01:49.8640555+00:00",
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00",
"is_mobile_installation": true
},
"job_type_id": "0b7cf333-0b0a-4e62-85e9-7a7dd12054a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "f43672f1-e106-409e-ab43-d2092c9a608f",
"name": "sample string 2",
"sales_organization_id": "9e6d3f3e-2c21-4128-ae47-12dcba0e1a28",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00",
"code": "sample string 7"
},
"job_priority_id": "30ee2f81-3d29-4cd6-8717-8db718bac506",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "df71742d-e6ca-4630-b355-3aaf8da6d1e9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ce18b5bf-4396-4113-8a73-e66e300d0796",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
},
"job_status_id": "9badc11b-6d03-489b-8679-35ffaaeed4c4",
"job_status_code": "sample string 11",
"db_address_id": "892a984d-83f7-4bc6-9040-7ab97bfecba6",
"contact_id": "d1ec23b0-c450-41e5-b2d8-63bc019f53f5",
"requested_by_company_id": "8cfcdc04-ead4-4ef3-ae1b-8f08ddeae89d",
"requested_by_contact_id": "90a5ebd4-f92a-4b2a-92da-5c238d7f0b63",
"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-05-30T01:01:49.8640555+00:00",
"due_date": "2026-05-30T01:01:49.8640555+00:00",
"date_create": "2026-05-30T01:01:49.8640555+00:00",
"date_update": "2026-05-30T01:01:49.8640555+00:00",
"date_closed": "2026-05-30T01:01:49.8640555+00:00",
"suggested_user_id": "7c709ae0-57b2-46b3-9c83-3ac4749ec95d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9027c155-4a97-4311-bb7f-44cee8e5540c",
"db_language_id": "f986031e-699b-430c-b896-4dd11cca7f2a",
"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-05-30T01:01:49.8640555+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1ad8e9df-5bf2-4d30-9b62-7083fcf492ac",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "20363bc7-e240-4f6e-bf25-6487b368e28b",
"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": "d278616b-1a1a-4710-9c5d-158ab1ca34ff",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2b91b643-ec74-4d4b-9788-9b8253afd71f"
},
"suggested_date_start": "2026-05-30T01:01:49.8640555+00:00",
"skill_id": "a48b79ef-63c9-475e-b830-7b4326c96fee",
"skill_code": "sample string 32",
"skill": {
"id": "d3941f4b-5f09-4491-aaac-5893e98d1724",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ee099c9b-ab1f-47ec-9f84-d6da359c985c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed223915-c67d-489f-8904-5d5b47ae2c27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ae9b22-d276-4c17-b16a-a37b50f4c86a",
"db_currency_id": "97214781-3988-4c5c-9635-9ac690367698",
"db_language_id": "dccc9b7a-8b3d-4842-8c89-89bb462d6d99",
"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-05-30T01:01:49.8640555+00:00"
},
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cfcc9d93-6354-4e58-a1bd-d5efd5a4fb48",
"date_reported_by_company": "2026-05-30T01:01:49.8640555+00:00",
"id2": 36,
"company_id": "28a1d201-3275-4fc4-b170-74289adee757",
"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": "de33f14f-68ee-4d89-a344-b26c96cd0abf",
"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-05-30T01:01:49.8640555+00:00"
},
"work_instruction_details_id": "55872e97-b4af-4241-8a82-89fe94999ce0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0730a701-542f-4cd1-915d-76dde4bbfe4a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5dc9a143-080c-4e54-a8ef-ec34933bf75b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T01:01:49.8640555+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": "53600681-f94b-45df-b64f-66fc2b2a6985",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T01:01:49.8640555+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.