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": "60d04cbf-75bf-4341-9660-2d924662b74a",
"jobs_id": "edacd3ce-5c9c-4fd5-8255-d65b3f4d885f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "be42a1c0-097b-48ca-a1b0-142a24bdb7a7",
"_parent_id": "ce84c6af-6c12-4502-8ba3-f6afecb642cc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9d537ba1-9ee1-4055-a574-aa23578a86ef",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e28f028c-1819-496d-9632-acc09dcd423d",
"_parent_id": "13024109-ecd5-4877-96e7-a32da2668026",
"root_parent_id": "f3ab35c7-28ce-49b5-a70d-4758eacaac5f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "92efcaf8-7396-4cd6-ab54-70f86288b4a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "75bae2e3-badd-4d99-813f-d25eda8526d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "618ff3ba-0362-409c-950e-aa736a4d1c44",
"_parent_code": "sample string 6",
"sales_organization_id": "4a89c8d4-bff8-49ab-885a-129e44323875",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00"
},
"equipment_model_id": "5c00f3bd-b73b-4c48-a611-b55f5387e7ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "961a12d6-fe60-4ac7-8772-9d8823570971",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7064304d-9bb0-4f60-981d-b54c0501049c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fd9b57dc-6e0c-4272-b3a2-006455b2932d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "310b3b4b-b8f5-4a00-a87f-fa2b9853eecb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00"
},
"equipment_family_id": "6e9b49b8-815d-46b5-969e-edf80ee03aba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "75bae2e3-badd-4d99-813f-d25eda8526d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "618ff3ba-0362-409c-950e-aa736a4d1c44",
"_parent_code": "sample string 6",
"sales_organization_id": "4a89c8d4-bff8-49ab-885a-129e44323875",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00"
},
"date_in_production_since": "2026-06-09T13:11:14.7406501+00:00",
"date_out_of_production_since": "2026-06-09T13:11:14.7406501+00:00",
"date_end_support": "2026-06-09T13:11:14.7406501+00:00",
"sales_organization_id": "162331b0-8ce9-4b99-a33f-54d0235dc57e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+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-06-09T13:11:14.7406501+00:00"
},
"project_status_id": "920f344c-881f-45c4-8f25-5f50897a8a3b",
"project_status_code": "sample string 10",
"project_status": {
"id": "dfc771f4-c5e9-49fc-ad13-b8c0137a1533",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b72b042a-587c-4e3a-a7e4-d568efda77c7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00"
},
"company_id": "8db4f6c7-9988-4ed6-9b2c-6d6297227086",
"company_code": "sample string 12",
"db_address_id": "c3853821-54d7-4f40-a8d7-1f1f010a448a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4919d313-c65f-4b53-9845-8f1f203d1380",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "47eba8f8-a450-4ba4-b6fa-34c84634b0c6",
"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-06-09T13:11:14.7406501+00:00",
"date_create": "2026-06-09T13:11:14.7406501+00:00",
"date_update": "2026-06-09T13:11:14.7406501+00:00",
"updated_by_user_id": "53431d9b-d0f1-49bf-8368-b4bdb3daaa70",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T13:11:14.7406501+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T13:11:14.7406501+00:00",
"date_last_job": "2026-06-09T13:11:14.7406501+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T13:11:14.7406501+00:00",
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00",
"is_mobile_installation": true
},
"job_type_id": "2221d406-c3e5-4eaa-89c3-b6a3bec8ca9f",
"job_type_code": "sample string 7",
"job_type": {
"id": "9b2163c4-83e1-4eaf-b0de-509f44f46c00",
"name": "sample string 2",
"sales_organization_id": "28acb03a-408a-4e30-b198-acea5e3b2c07",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00",
"code": "sample string 7"
},
"job_priority_id": "334a5206-fe54-4f78-a580-73cb8be3651a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "01327232-a7ed-47b8-8080-0b5d9dfe1b38",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "66d770b3-8532-49a7-9d37-757102d8e63e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00"
},
"job_status_id": "0c9fe6c9-0626-4d44-aaa1-4a5d62bab772",
"job_status_code": "sample string 11",
"db_address_id": "fee7d114-108e-4067-be4e-36b16c96dc39",
"contact_id": "36ad3788-0a57-4f16-b0c3-1a646a5bddbb",
"requested_by_company_id": "65e951e2-86cb-4ff8-ba11-3dfd2795deac",
"requested_by_contact_id": "242b78dd-d36f-4071-8b25-bb6a67f193ba",
"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-06-09T13:11:14.7406501+00:00",
"due_date": "2026-06-09T13:11:14.7406501+00:00",
"date_create": "2026-06-09T13:11:14.7406501+00:00",
"date_update": "2026-06-09T13:11:14.7406501+00:00",
"date_closed": "2026-06-09T13:11:14.7406501+00:00",
"suggested_user_id": "1632b818-e5be-4be7-b5c5-fa6509785f58",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ddaf2de8-2c18-4e48-b4bb-9e6f50e8b2e5",
"db_language_id": "d3a4191a-7928-4fc8-a4a1-b94a681add74",
"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-06-09T13:11:14.7406501+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aa2c146d-dcd4-4c23-b145-216754e0b7ef",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ab35ab7e-f21b-4bd4-88ae-0f200f5aa677",
"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": "cf2dca58-fa91-49ef-9ea9-12d45783bc5d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c437bfe7-bcfa-476b-8df9-6b6a23d58ea0"
},
"suggested_date_start": "2026-06-09T13:11:14.7406501+00:00",
"skill_id": "d791cc1b-35c4-4018-bea5-b691d10df4be",
"skill_code": "sample string 32",
"skill": {
"id": "7bc6f03f-6698-4fe6-a725-6fcc004bcd19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2cf1f861-b543-4c05-b008-140da7cc2890",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "769678f0-9a24-4618-b99c-de15da71a839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1e6d0b1-10f5-436a-844e-54e02be5b9e4",
"db_currency_id": "538d8f15-da01-4efd-9029-22247ea3a7cb",
"db_language_id": "70a76d1c-2049-41ab-82f1-5468788b2daf",
"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-06-09T13:11:14.7406501+00:00"
},
"modified_dateutc": "2026-06-09T13:11:14.7406501+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "61edbd47-1fa2-4650-92dc-d0e4adbdad77",
"date_reported_by_company": "2026-06-09T13:11:14.7562718+00:00",
"id2": 36,
"company_id": "6537e019-d6a2-496d-b6fc-557c46b2e53c",
"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": "029f9afa-2198-4308-b176-ca470bc53595",
"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-06-09T13:11:14.7562718+00:00"
},
"work_instruction_details_id": "3bbf9a1f-da97-4ef2-b06f-ee9eb05c961d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c7719b79-2477-4994-bb6a-50e332cf1b48",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "254076b6-fdda-492d-9f10-d9cee874522b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T13:11:14.7562718+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": "e103f1c4-7991-4636-b3a6-2677e9404664",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T13:11:14.7562718+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.