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": "04d30cba-ba52-4d8d-bc3f-863936c0976a",
"jobs_id": "4cbe4f14-1aac-4363-a26d-0f55651ce57f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0be74fc6-5d23-482b-b9b4-6abd71432a56",
"_parent_id": "d1c70c44-bb64-41f8-9eaa-eb3c81a9321b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e1635f87-9911-4d81-8027-5ba0ddebacc1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0bef8ef6-0ec6-4303-871d-657e650594a5",
"_parent_id": "dd264c9a-e82c-43a3-bb55-8c86cc69c777",
"root_parent_id": "7639ca9f-70f9-4fab-879f-30b2c494bead",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5d45b852-4781-44e7-be7c-00239ff54565",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8c1a4404-24b1-4db9-adda-e7d2a8da50e7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41dca5c2-12eb-420b-b559-37e75d6efd57",
"_parent_code": "sample string 6",
"sales_organization_id": "80daa4da-91a4-4eb6-818b-656972eceaa4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00"
},
"equipment_model_id": "039850c5-53ae-4b61-8030-431deb92a9dd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c9e9276e-1bde-4976-96ea-ea009edbf3ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c4b37ed2-4c08-4d66-9e58-998bc5f6abe9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05aa6c6e-5e0d-431f-8d4e-e1f19df5290b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e425e7a0-1bbf-4ddb-b2e0-42672c260f8b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00"
},
"equipment_family_id": "64c9cc35-c8b3-433e-bebe-0ad5d948df55",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8c1a4404-24b1-4db9-adda-e7d2a8da50e7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41dca5c2-12eb-420b-b559-37e75d6efd57",
"_parent_code": "sample string 6",
"sales_organization_id": "80daa4da-91a4-4eb6-818b-656972eceaa4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00"
},
"date_in_production_since": "2026-07-27T04:30:24.430495+00:00",
"date_out_of_production_since": "2026-07-27T04:30:24.430495+00:00",
"date_end_support": "2026-07-27T04:30:24.430495+00:00",
"sales_organization_id": "f65b79eb-5e01-4931-9e08-7a4f7e24a1b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+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-27T04:30:24.430495+00:00"
},
"project_status_id": "91ca62c6-6f41-4223-a53d-c56ca61312a5",
"project_status_code": "sample string 10",
"project_status": {
"id": "cf315e23-1421-45a4-a7a6-f49cad4cbc9a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2cbba066-10b9-4e99-bac6-f959d494e02d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00"
},
"company_id": "120f1164-c269-4b59-bda7-542084837759",
"company_code": "sample string 12",
"db_address_id": "8bb43ccc-ce64-4e4f-b55e-b31689e64d5d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d6c4faef-08d0-4742-92ea-6a02ccc65905",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dfae72d5-9312-4f55-9172-033f285db9e7",
"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-27T04:30:24.430495+00:00",
"date_create": "2026-07-27T04:30:24.430495+00:00",
"date_update": "2026-07-27T04:30:24.430495+00:00",
"updated_by_user_id": "fe04322d-1b54-4265-9c89-6bb7ce4f5a91",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-27T04:30:24.430495+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-27T04:30:24.430495+00:00",
"date_last_job": "2026-07-27T04:30:24.430495+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-27T04:30:24.430495+00:00",
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00",
"is_mobile_installation": true
},
"job_type_id": "25ff4ad9-a962-40b9-b5c7-6cc14aa4685d",
"job_type_code": "sample string 7",
"job_type": {
"id": "d6832b05-59b3-4130-a298-51cfbf131c3d",
"name": "sample string 2",
"sales_organization_id": "66b44419-62eb-404f-ae88-0cbad38b04ff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00",
"code": "sample string 7"
},
"job_priority_id": "691e558d-bdcf-43c3-8eef-a7e07085cbda",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9adc2bec-0506-4440-971c-6478fb0e2a7f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1f827ef2-7edc-49bb-99c6-d90cec94dd6a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00"
},
"job_status_id": "709b80f3-8f6a-4e75-9893-0551aac2db4d",
"job_status_code": "sample string 11",
"db_address_id": "806b9567-47ec-4992-9d08-4ff6aeeffcc6",
"contact_id": "d15d7f00-e9e2-416b-a2c5-2135d3ca169c",
"requested_by_company_id": "55937c72-c90e-480e-a8a2-1afb1065f88c",
"requested_by_contact_id": "94ae55f8-5838-47cf-8311-ff59e0c9e74c",
"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-27T04:30:24.430495+00:00",
"due_date": "2026-07-27T04:30:24.430495+00:00",
"date_create": "2026-07-27T04:30:24.430495+00:00",
"date_update": "2026-07-27T04:30:24.430495+00:00",
"date_closed": "2026-07-27T04:30:24.430495+00:00",
"suggested_user_id": "81acb9ee-eca9-4106-952a-96aa186e108f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3aa293cd-fd93-464a-9571-c2a9db57435f",
"db_language_id": "972bf2a4-452b-4b2b-a748-d724511b6b8c",
"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-27T04:30:24.430495+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6a29a36f-a4c2-4985-923e-6277857be15a",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "48b12658-f6cc-4e0d-876c-b75423ba5690",
"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": "99dea23b-1113-4c69-a44d-d795dfeae659",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b0242de4-4878-4bb0-9dc2-49acee9dcbac"
},
"suggested_date_start": "2026-07-27T04:30:24.430495+00:00",
"skill_id": "e3eb0571-6901-49d2-ac33-f02cbb81138b",
"skill_code": "sample string 32",
"skill": {
"id": "76798706-bc13-4d49-9a7c-c2e1780888c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9391069d-9e6a-46f0-bcee-b47cbcd62b8d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7077ac91-8220-4108-98d1-a7b41d3969e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3eae51b2-418c-4ff7-bd90-65560d8b1ab4",
"db_currency_id": "5e5be424-39c5-4f5f-ad1d-ce4dd981da8d",
"db_language_id": "e66f3d1a-22e2-40fc-b055-dc294145d12d",
"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-27T04:30:24.430495+00:00"
},
"modified_dateutc": "2026-07-27T04:30:24.430495+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f632607f-781d-4208-86d3-ba807558203e",
"date_reported_by_company": "2026-07-27T04:30:24.430495+00:00",
"id2": 36,
"company_id": "bfe46113-ece2-48a6-ae60-5c4f229d064b",
"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": "f506f285-7496-4b6c-baee-8f05ddd07253",
"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-27T04:30:24.430495+00:00"
},
"work_instruction_details_id": "e530398d-9bfb-483f-9f4b-dabeba01a035",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7ee3613d-cd8f-473e-b534-4bf1f41e51a9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f222a7bc-281b-4fa2-aabe-115dd3c6f3df",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-27T04:30:24.430495+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": "0f9503f8-464d-4fae-8365-a7a6f3891d8b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-27T04:30:24.4461241+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.