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": "952d5d9b-f6c3-4fb8-b9ba-33e3a6bce04d",
"jobs_id": "7678d14a-f305-4ff8-bd4a-bd9a3adb66e0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1bde0918-92b2-4c09-82a2-8aebee34309d",
"_parent_id": "f811de48-05f3-4373-b7e8-6d6c0e30f1d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "67dcb6af-010a-454d-abe0-9fd39f478fcb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "327651da-d5bf-4fe8-9280-d92240ec7daf",
"_parent_id": "628da132-0f71-4052-8f6b-5f65c1e79db2",
"root_parent_id": "cc55aa58-ded4-4cb6-b045-2ba3ef77457b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "556096ca-c64d-4f66-b660-545f62bb87be",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4b25ce6a-bd98-42af-8690-482bce439b54",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "395112d7-5d32-481c-a139-05e021088b8c",
"_parent_code": "sample string 6",
"sales_organization_id": "6d676faf-77d0-4aaa-9b55-8177b5db1240",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
},
"equipment_model_id": "efef33b8-906a-4800-8cf1-a10bb33cc762",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dc0bc7a5-03b7-4c0a-adaf-4b0b65fd334c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "451b56c6-a0b1-495d-bf92-faebe2f18eb0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3a033be-11d2-4bcd-9381-f6a347c4b533",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6d8784aa-eb1d-4f08-830d-aaf925277038",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
},
"equipment_family_id": "576ed1d3-0574-4216-888b-e8fc0a235496",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4b25ce6a-bd98-42af-8690-482bce439b54",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "395112d7-5d32-481c-a139-05e021088b8c",
"_parent_code": "sample string 6",
"sales_organization_id": "6d676faf-77d0-4aaa-9b55-8177b5db1240",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
},
"date_in_production_since": "2025-10-02T19:58:12.9509671+00:00",
"date_out_of_production_since": "2025-10-02T19:58:12.9509671+00:00",
"date_end_support": "2025-10-02T19:58:12.9509671+00:00",
"sales_organization_id": "563d0cce-f7b2-4612-8b70-ea39b7b8be8b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+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": "2025-10-02T19:58:12.9509671+00:00"
},
"project_status_id": "f6e68e01-a5d1-4c9b-8cb8-7659fdb15f08",
"project_status_code": "sample string 10",
"project_status": {
"id": "ce9fe9b7-43bd-49d5-8582-199f377fbf27",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bb917c84-5a27-4df2-b270-38355f873417",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
},
"company_id": "ec6e3bab-336b-4ef1-9074-8b088973ab29",
"company_code": "sample string 12",
"db_address_id": "f48c3db7-fcb8-4dce-a276-655a81b96da4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fb4ec8b1-3750-4af9-9943-d802791f211e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b8da7c27-0b50-46a7-94aa-7150da55ac71",
"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": "2025-10-02T19:58:12.9509671+00:00",
"date_create": "2025-10-02T19:58:12.9509671+00:00",
"date_update": "2025-10-02T19:58:12.9509671+00:00",
"updated_by_user_id": "f994c33f-9d32-4b5f-ab90-dbaea117af1d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-02T19:58:12.9509671+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": "2025-10-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-02T19:58:12.9509671+00:00",
"date_last_job": "2025-10-02T19:58:12.9509671+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-02T19:58:12.9509671+00:00",
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00",
"is_mobile_installation": true
},
"job_type_id": "13d0ea72-7923-4f0d-8899-489f313a3d7c",
"job_type_code": "sample string 7",
"job_type": {
"id": "9bf57987-1a46-4c9c-ba1e-9062080cf762",
"name": "sample string 2",
"sales_organization_id": "02145783-36b2-431d-a22f-46524dedab53",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00",
"code": "sample string 7"
},
"job_priority_id": "dcb734e3-6ec2-4828-9e36-d7dc604345de",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0d1b4a04-eab1-4930-9719-4bd2c7941589",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a2673de1-8bdf-4877-8db3-a93786019843",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
},
"job_status_id": "e9d3e019-0996-4833-900c-f720d32ef853",
"job_status_code": "sample string 11",
"db_address_id": "9ec359c6-eb01-4b83-9e98-972bc1a969cc",
"contact_id": "66ce0f47-c21f-4bce-a2ea-3ccf609cb7d5",
"requested_by_company_id": "ce26f6c2-01fd-42b8-8689-52ecc2b533f4",
"requested_by_contact_id": "f00cb96e-ab68-447c-9a0b-09f4121526da",
"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": "2025-10-02T19:58:12.9509671+00:00",
"due_date": "2025-10-02T19:58:12.9509671+00:00",
"date_create": "2025-10-02T19:58:12.9509671+00:00",
"date_update": "2025-10-02T19:58:12.9509671+00:00",
"date_closed": "2025-10-02T19:58:12.9509671+00:00",
"suggested_user_id": "9195f116-8ab9-411d-b5e3-c69038c00817",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "615c6891-1412-42a9-be6d-5587aa7e7acd",
"db_language_id": "0a3a1c1b-abf2-463a-b5ea-c346fc33f9c0",
"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": "2025-10-02T19:58:12.9509671+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12588877-c59d-4f62-9688-0684af870882",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2fb3ba71-06e8-4cac-9e6d-3d19aa7b90ab",
"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": "d0564365-e504-40b8-b28f-d52bf3e1b57d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2a6d9909-3be7-4c0e-80f6-46ee071970b3"
},
"suggested_date_start": "2025-10-02T19:58:12.9509671+00:00",
"skill_id": "8ccb7133-9261-4a48-b6c6-64e357d18e35",
"skill_code": "sample string 32",
"skill": {
"id": "6d80ca02-1a5c-4380-b59f-e2f6dce389b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "723d02b6-30a9-4e6e-ae67-134b9ba57299",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f3a28f0-4a44-45f6-b95b-7e3b5792db94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3642c175-35cb-444e-8896-ac00808d8e17",
"db_currency_id": "6b98d743-00a7-4c08-b761-cea09ff20e20",
"db_language_id": "f498de01-dc20-4b18-be68-f7cea492c0a0",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "06250006-1ea8-43d1-83b0-7f6331b6b088",
"date_reported_by_company": "2025-10-02T19:58:12.9509671+00:00",
"id2": 36,
"company_id": "8950268c-a8ca-46e5-b1bc-5d39520dbf8d",
"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": "7af79be4-3d9c-43e3-a93c-b239cdf09800",
"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": "2025-10-02T19:58:12.9509671+00:00"
},
"work_instruction_details_id": "5af9b190-bbd8-4328-b90f-16be20934ce1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "86cd93a1-cd64-4c8b-89b0-31d5c7605b57",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ee4c5815-3c51-4b67-a71e-153cea49a68f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-02T19:58:12.9509671+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": "13d6dcf6-1c87-4b8b-89f9-f959275f2520",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-02T19:58:12.9509671+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.