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": "67e90aeb-e77d-4716-8994-553118d3924b",
"jobs_id": "5cac9c86-61e4-44a9-a30b-ff215f95b2da",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1de083d7-66fd-4b56-b376-ef038a6ccb69",
"_parent_id": "e9e5e1cc-5830-42c4-a5c3-94e023863904",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "970111da-24ff-4d8d-9827-3f97b2513cda",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5c04ac5f-1b6b-4fc8-8383-62a4abd73529",
"_parent_id": "b05a617e-dc0b-4209-89ca-c4809311dfbd",
"root_parent_id": "d2de49b9-4a7d-4774-a90d-602a04da0140",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e9beb2b-8f40-4d36-a0a2-09124a78e216",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b50d2dfd-bd3a-41df-90f9-6992f1f12d10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b296962f-7373-4a75-a864-cafeac0951ff",
"_parent_code": "sample string 6",
"sales_organization_id": "8e5ecbf2-43a4-45c4-8c1d-0a944ac73be4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
},
"equipment_model_id": "a87d4948-df37-4674-b53d-ddab3dd534b8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "62f6181e-7f06-4fbc-a9dd-b25ce1c82278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3174fc69-fdca-461a-b356-7c7b7cf47129",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ec617728-2434-4e90-b7de-e4c9d2a261be",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2d57dd99-7ebb-4d0c-a4cc-16e5a1aa293d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
},
"equipment_family_id": "df4d1203-129e-4598-881e-b10e1f238f9b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b50d2dfd-bd3a-41df-90f9-6992f1f12d10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b296962f-7373-4a75-a864-cafeac0951ff",
"_parent_code": "sample string 6",
"sales_organization_id": "8e5ecbf2-43a4-45c4-8c1d-0a944ac73be4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
},
"date_in_production_since": "2026-07-05T21:56:50.1796934+00:00",
"date_out_of_production_since": "2026-07-05T21:56:50.1796934+00:00",
"date_end_support": "2026-07-05T21:56:50.1796934+00:00",
"sales_organization_id": "bf8d6445-460b-4f37-9e5a-82282ac2a8e9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+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-05T21:56:50.1796934+00:00"
},
"project_status_id": "f861696a-62fd-40f6-8464-ab6abc98de76",
"project_status_code": "sample string 10",
"project_status": {
"id": "4519c28f-3cdc-4cfe-a5f7-6c89145da80d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65516fbb-df9d-42b7-81e7-1cf4fd032d42",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
},
"company_id": "0c43ed91-8e58-4d78-9e3f-49bcb0980a00",
"company_code": "sample string 12",
"db_address_id": "43f312ba-db2f-44b0-abfd-57330d428c3b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2de7b0a2-0614-47b8-bec1-bb022c231269",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2b1127bb-5f06-4d9e-b09d-79e432e8764c",
"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-05T21:56:50.1796934+00:00",
"date_create": "2026-07-05T21:56:50.1796934+00:00",
"date_update": "2026-07-05T21:56:50.1796934+00:00",
"updated_by_user_id": "c0c64837-958e-40c6-adaf-7cb988a1a65d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-05T21:56:50.1796934+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-05T21:56:50.1796934+00:00",
"date_last_job": "2026-07-05T21:56:50.1796934+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-05T21:56:50.1796934+00:00",
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00",
"is_mobile_installation": true
},
"job_type_id": "1b9c70ee-9e2e-40db-a658-ebdbaa6e9bdb",
"job_type_code": "sample string 7",
"job_type": {
"id": "acbde4a1-e6bc-47d3-840b-8558f369a729",
"name": "sample string 2",
"sales_organization_id": "612fefe4-dd2a-454f-beb6-6c438005133e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00",
"code": "sample string 7"
},
"job_priority_id": "adcb6253-fe49-41df-b9ce-6d80b06ef5db",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "97457a3f-a5ed-437c-a386-f02d75465d51",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8cdc1f5e-537b-4b88-b43b-b7ffe1fd9c81",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
},
"job_status_id": "0d5825c1-3035-4f6f-aabe-5cb3eb4deacb",
"job_status_code": "sample string 11",
"db_address_id": "9cd55ad1-ad89-471a-aa24-64703355eaa7",
"contact_id": "47d03aaa-8ddb-4810-993f-768a3512b4de",
"requested_by_company_id": "a7076177-ccf8-46b8-9a03-2eac5b6bcb2e",
"requested_by_contact_id": "2f5f6353-bce4-4640-a495-5241ee314fd0",
"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-05T21:56:50.1796934+00:00",
"due_date": "2026-07-05T21:56:50.1796934+00:00",
"date_create": "2026-07-05T21:56:50.1796934+00:00",
"date_update": "2026-07-05T21:56:50.1796934+00:00",
"date_closed": "2026-07-05T21:56:50.1796934+00:00",
"suggested_user_id": "ada7d04b-4dc7-456c-a794-c5df635b65aa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "73701f6d-dca3-4cd0-9b83-ce79d4bc0085",
"db_language_id": "c73922a2-dac9-4f8f-a749-8dabaf9a5bc9",
"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-05T21:56:50.1796934+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dce24a76-0b64-4163-87ee-6e96275c3165",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b76d6d5-ad1f-42b4-9cd8-1213b591d8e7",
"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": "c8d1acb1-313c-4e7c-9bce-0b26d12f618f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8f9090e-ece7-4933-92d5-6faf975a00e2"
},
"suggested_date_start": "2026-07-05T21:56:50.1796934+00:00",
"skill_id": "3beff0b6-5af9-4e58-abc8-eb5f94c0c626",
"skill_code": "sample string 32",
"skill": {
"id": "2c415757-87e7-4614-9134-e67d4a470a51",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "95308eef-f0bf-48a5-9f4f-698b02168b6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4d66845-5b65-4522-becd-41d9914b075a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e271131-1bad-4e93-9ba9-3c7887dd043a",
"db_currency_id": "4f4a6341-9e28-4719-bc9b-cac78abf8b73",
"db_language_id": "ee4e1763-f541-4990-8c6f-ef63fa5bcdbb",
"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-05T21:56:50.1796934+00:00"
},
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1bd8edde-b96f-4243-8750-d173b5721924",
"date_reported_by_company": "2026-07-05T21:56:50.1796934+00:00",
"id2": 36,
"company_id": "0e0b7b1f-9ca3-4261-b4c6-e04a667ef178",
"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": "c6639d0c-61c0-4f9e-9add-6d92b12c61c7",
"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-05T21:56:50.1796934+00:00"
},
"work_instruction_details_id": "92227e35-be86-46c2-a344-9d925ef5c401",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f051553f-a8d2-4969-bd87-f42362ec7126",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5a0c45ef-605d-48c0-803b-7d337f64d078",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-05T21:56:50.1796934+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": "80943554-85c2-4fb1-b531-dba7ef9754dc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-05T21:56:50.1796934+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.