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": "d8fc4129-d4d8-4b99-b7c4-38a842250c98",
"jobs_id": "c0c6f5e6-c70b-4519-87a3-551dd7bd4a40",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bccedbfa-5f1c-40fe-9041-9388b323950a",
"_parent_id": "0a0b94cc-7a46-488c-a383-854e3a3856c3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "30687ead-e68f-4836-927a-2f394e6dacef",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3fb6a70f-4350-4f9b-833a-56f7e121410e",
"_parent_id": "1c59fb3b-b6fe-4d77-b544-c9e7090aaad7",
"root_parent_id": "dda50d00-6b1a-44b9-a397-7549658c7d8a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "77304c0e-9ce6-4e71-a979-80663b7cca5b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e9f1f4f7-a7c0-471a-92a2-66414ee52f24",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bcb586af-0f64-48b1-99a9-79488ba7b699",
"_parent_code": "sample string 6",
"sales_organization_id": "04266c6d-e94d-4fc2-8481-d3d60ff0e791",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
},
"equipment_model_id": "7d993b6d-f8a5-4471-b50e-651691d57047",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1833602e-140e-4ad4-b5df-9c78c86d8865",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "aa9d2a6e-4267-44b7-9126-e2510b532fb3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "daa3805b-f950-4516-aeaa-de266e511def",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1185426e-bbaf-4c09-ac44-f47d2026d18e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
},
"equipment_family_id": "3570dfdb-24dc-494b-a1f6-9ffc60ae298f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e9f1f4f7-a7c0-471a-92a2-66414ee52f24",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bcb586af-0f64-48b1-99a9-79488ba7b699",
"_parent_code": "sample string 6",
"sales_organization_id": "04266c6d-e94d-4fc2-8481-d3d60ff0e791",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
},
"date_in_production_since": "2026-02-25T15:43:28.4598322+00:00",
"date_out_of_production_since": "2026-02-25T15:43:28.4598322+00:00",
"date_end_support": "2026-02-25T15:43:28.4598322+00:00",
"sales_organization_id": "02f550f7-218a-4d65-b1ac-abd5b14737d9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+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-02-25T15:43:28.4598322+00:00"
},
"project_status_id": "65099992-f40d-477d-b2b6-842f0712ac64",
"project_status_code": "sample string 10",
"project_status": {
"id": "766bee85-ecc3-4307-a411-3f65ec5b3714",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "100eb275-4144-4d3b-ab6c-83a3b532b3e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
},
"company_id": "12be6632-1ff7-4b67-a4e6-da284ec5ce90",
"company_code": "sample string 12",
"db_address_id": "ba611ea0-4581-4112-96ec-cc4062803d5f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4c878084-f764-4d49-a04c-91b9e859e316",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "012f92f3-1ffa-437b-ad3f-d1aeaf00055c",
"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-02-25T15:43:28.4598322+00:00",
"date_create": "2026-02-25T15:43:28.4598322+00:00",
"date_update": "2026-02-25T15:43:28.4598322+00:00",
"updated_by_user_id": "7af418cc-33ba-4633-9650-d768e5dbff9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T15:43:28.4598322+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-02-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-25T15:43:28.4598322+00:00",
"date_last_job": "2026-02-25T15:43:28.4598322+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T15:43:28.4598322+00:00",
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00",
"is_mobile_installation": true
},
"job_type_id": "0a8fc17d-723e-43af-9c38-af97bcd582e1",
"job_type_code": "sample string 7",
"job_type": {
"id": "b7c80280-a50f-4b97-9276-665b854a428a",
"name": "sample string 2",
"sales_organization_id": "be66b703-74f3-4ba5-91f1-eabfdab511e8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00",
"code": "sample string 7"
},
"job_priority_id": "3ddc9f0a-a121-43d9-bcc3-bc152b561489",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d9beb140-0a5a-413f-89ad-751ac6b75b57",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cd517f4f-e645-4cb0-8d0b-20fc924b84c7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
},
"job_status_id": "fd06a2f6-968a-4148-8149-3dc90e6d07cf",
"job_status_code": "sample string 11",
"db_address_id": "02b0bb52-28b2-4a2c-84e7-98ba0c6a7081",
"contact_id": "a1f43124-9ba0-417c-a21d-bb588ab1e60d",
"requested_by_company_id": "aaee0dcf-7106-41cf-9181-aa86cbcbd84d",
"requested_by_contact_id": "97d5643d-cfea-4883-8337-b0484df6abda",
"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-02-25T15:43:28.4598322+00:00",
"due_date": "2026-02-25T15:43:28.4598322+00:00",
"date_create": "2026-02-25T15:43:28.4598322+00:00",
"date_update": "2026-02-25T15:43:28.4598322+00:00",
"date_closed": "2026-02-25T15:43:28.4598322+00:00",
"suggested_user_id": "3b27557f-b185-4404-8c54-c1e2168bb0ae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b09ce180-8823-4e9b-93df-d2f4ec3ee52b",
"db_language_id": "2a96ea89-2ece-4f19-abd5-c9bf3904aca4",
"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-02-25T15:43:28.4598322+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b064b4cf-f972-4042-acc1-db73be2ade1b",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "accb2f51-6290-4424-bd43-74b117afc6d7",
"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": "5e3a7a07-c2b2-46c2-9f1d-f84b589c30b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "156c9ab4-53b6-4a78-9c43-5a1c3efd4167"
},
"suggested_date_start": "2026-02-25T15:43:28.4598322+00:00",
"skill_id": "a1794398-f76c-48f4-945b-b26b936430d9",
"skill_code": "sample string 32",
"skill": {
"id": "46c24b35-315a-4c1d-8202-de29fe9bfd27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "14a87b1b-1f3e-4c88-b78c-abb8b063a029",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd17433d-5bbd-44c5-b860-58c8681b65a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1ad0e2cd-c91c-4b88-a4ed-9657da528a2e",
"db_currency_id": "44b13786-7302-4506-b8de-2d9c774da9b5",
"db_language_id": "7582fc5c-5764-45cc-9101-b0ef94328bab",
"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-02-25T15:43:28.4598322+00:00"
},
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "11817a40-7257-4fc5-a493-0a69cca67c0d",
"date_reported_by_company": "2026-02-25T15:43:28.4598322+00:00",
"id2": 36,
"company_id": "00fde56c-6bc3-4f58-aeb0-836b32c24e58",
"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": "2c92f1bc-0a85-495f-a4bd-fbb0411a9355",
"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-02-25T15:43:28.4598322+00:00"
},
"work_instruction_details_id": "1bbdd6f4-096d-44d3-895d-e28c6566fd99",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "23fa9860-13f9-4fa8-b45a-d6ef721b6632",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c8d70750-34cf-48c3-9b77-7840b4e27b93",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T15:43:28.4598322+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": "2e333524-c563-4c75-8bbd-931c91eec766",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T15:43:28.4598322+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.