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": "b4bfd816-6670-46ef-8fdb-e23d982c0368",
"jobs_id": "f2242d82-071f-49ac-bbcc-6cca561b2c79",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8a42cbd6-5ddc-464e-b719-c9fa9a4d16fd",
"_parent_id": "a9af1abe-f357-4f2e-b1df-28307f617a08",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0373dfdb-c27e-4ae3-bb1b-add664f8e3d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ef11fce6-131d-4e4b-81bb-b110333eaf93",
"_parent_id": "9f429f8b-72f4-4217-a86f-7d6d92e9c186",
"root_parent_id": "1f75db01-f8e4-4401-b9e1-6f83431dfcd0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b14e123b-ff64-4f37-b714-54de9052e32f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f5c68464-f838-41df-af5a-9cf900644b7e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "22ce1a33-7bb9-4613-905f-5c2155a89116",
"_parent_code": "sample string 6",
"sales_organization_id": "ff7dbc8e-fedd-457a-b88d-52cca1560ef5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
},
"equipment_model_id": "9ac57db3-bfff-4372-907f-9772ecc328ae",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "68cab124-fdf0-4fe3-95b2-c3b0a44c8042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4892851b-cc38-4180-8c94-a6206abb0e3f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5b833cfa-796d-46d3-a389-9c4298743044",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e3f179b6-d2f5-4c51-a877-6d898b127340",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
},
"equipment_family_id": "a40dcf43-a15a-48c7-8173-d3ee0d0b86e0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f5c68464-f838-41df-af5a-9cf900644b7e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "22ce1a33-7bb9-4613-905f-5c2155a89116",
"_parent_code": "sample string 6",
"sales_organization_id": "ff7dbc8e-fedd-457a-b88d-52cca1560ef5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
},
"date_in_production_since": "2026-09-23T13:03:53.0561158+00:00",
"date_out_of_production_since": "2026-09-23T13:03:53.0561158+00:00",
"date_end_support": "2026-09-23T13:03:53.0561158+00:00",
"sales_organization_id": "122bc39a-af84-4b08-a5f5-34f0442226bc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+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-09-23T13:03:53.0561158+00:00"
},
"project_status_id": "871ca5f3-69c9-419e-8edf-b503ba4a25c5",
"project_status_code": "sample string 10",
"project_status": {
"id": "4c975f0c-9c3c-4059-a57d-e4429c9d9214",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "752f750e-9aa9-4149-886f-2d5043fb65e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
},
"company_id": "3521024c-302e-48fb-b0dc-0c43ae4954e4",
"company_code": "sample string 12",
"db_address_id": "cbf81f5e-496f-4c1e-86cb-eef349530227",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4596148e-3032-4020-967a-111bcd12fa29",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7737cd36-847c-4f0d-a99a-5383438e55df",
"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-09-23T13:03:53.0561158+00:00",
"date_create": "2026-09-23T13:03:53.0561158+00:00",
"date_update": "2026-09-23T13:03:53.0561158+00:00",
"updated_by_user_id": "5d126c40-0cff-4e81-b4fa-d2764e78ed24",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T13:03:53.0561158+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-09-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T13:03:53.0561158+00:00",
"date_last_job": "2026-09-23T13:03:53.0561158+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T13:03:53.0561158+00:00",
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00",
"is_mobile_installation": true
},
"job_type_id": "78d29ea1-6785-45ca-99b9-b33fb37ea503",
"job_type_code": "sample string 7",
"job_type": {
"id": "d8948704-3854-4bf1-9d33-dbffd68a28ef",
"name": "sample string 2",
"sales_organization_id": "0a628a3e-de28-4962-ba39-54a4a3be083f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00",
"code": "sample string 7"
},
"job_priority_id": "9f064679-af63-40ef-af4e-5c453c24d96b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f5eddf2d-bb64-4e3a-acad-705b73bebf79",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3f255204-d3a0-415e-b1be-c84b9b2e957f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
},
"job_status_id": "05fae9f3-0654-4627-9292-36917ca39b62",
"job_status_code": "sample string 11",
"db_address_id": "e9b94810-9ccb-4ff3-a068-5a5ad27b4ac7",
"contact_id": "3d117673-def2-4ed4-8007-c5e99ab658f9",
"requested_by_company_id": "e988e0ee-0f91-4f36-a630-f2905b8203b1",
"requested_by_contact_id": "a24ed0eb-a960-40d2-b21f-5ec15c6cc1a4",
"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-09-23T13:03:53.0561158+00:00",
"due_date": "2026-09-23T13:03:53.0561158+00:00",
"date_create": "2026-09-23T13:03:53.0561158+00:00",
"date_update": "2026-09-23T13:03:53.0561158+00:00",
"date_closed": "2026-09-23T13:03:53.0561158+00:00",
"suggested_user_id": "e42798ca-c08a-4875-9430-f4142b169db5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f900a332-0b9d-42d9-ab01-04d690fdc734",
"db_language_id": "cf11ab0a-a542-4590-8fb5-d9748b8c4274",
"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-09-23T13:03:53.0561158+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7155e9b8-b11f-4681-9d72-0eae5ab3fc0a",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "969f195c-c8b8-497d-a0f4-fe109355ab96",
"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": "8cb42750-35f4-49b1-bc5c-9bc42adc0354",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6b5fa2c4-780f-413a-837e-264a5437934d"
},
"suggested_date_start": "2026-09-23T13:03:53.0561158+00:00",
"skill_id": "f9a330de-7654-4862-a83e-4c48ae8d2492",
"skill_code": "sample string 32",
"skill": {
"id": "2f525d97-2000-43c9-aca3-0c397a0302bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e0121fd1-ea96-4fea-b941-077cb87a169e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ec96a78-4a67-484e-826e-d6d3c8695baf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2431d511-8a2f-4433-a5b1-7e90de9f19af",
"db_currency_id": "029c4053-f6c0-469c-b6a2-ccf2efd58d2c",
"db_language_id": "2d1f9566-1ee9-43b5-91e7-bb0c00e8f4a6",
"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-09-23T13:03:53.0561158+00:00"
},
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d361fcfd-e310-44cd-82d4-81bf3c6b2eb6",
"date_reported_by_company": "2026-09-23T13:03:53.0561158+00:00",
"id2": 36,
"company_id": "7031f41a-8df8-4a01-be5a-0e6539d1b199",
"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": "fc724361-c72f-46a9-8617-3a3d3908cfc3",
"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-09-23T13:03:53.0561158+00:00"
},
"work_instruction_details_id": "50941cd0-b56e-41fe-a257-f29ca6988868",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6f4c8c33-ead4-4dc9-9606-d89861f38c44",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a0924d64-5043-4812-8e5e-a85a0c2a580c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T13:03:53.0561158+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": "7de5919f-c480-482a-b31e-4afe87996df3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T13:03:53.0561158+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.