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": "77b01cdd-89d9-4b89-be16-d3ba18d10497",
"jobs_id": "e1383f35-58f8-4f21-a1e3-93755bb310b1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "34a8d2d0-82ff-4996-981c-9fe0dddf6a24",
"_parent_id": "19346b4e-c2e8-4007-b93e-a5043c110751",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2c9a4841-0d27-4fbe-92a4-d1b3d36994a2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "22129173-db87-4c1b-b013-c1d1e894ef22",
"_parent_id": "16ae2e50-1a4a-45d6-9093-ab4afb7e5cb7",
"root_parent_id": "36492730-2430-48ed-a288-170b505ce58c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bf0b8f6e-aa18-464f-a7d4-e02ce6fdfde9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e677b87-269d-44f8-b152-4eb31e9c77ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9c372d9e-2871-4e4b-bfa7-9c1b0d7ad562",
"_parent_code": "sample string 6",
"sales_organization_id": "06854c35-f345-4493-83c3-424fba286265",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
},
"equipment_model_id": "ab5ad4c9-d1f4-4ac1-9e7d-a3acc10fb1cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f577a7df-35ac-4325-889c-b129241f575b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eb8e0705-055f-467b-8223-327c2c70c171",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "da89bcf3-fc4b-4541-800f-e70d25d8d31d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ef457f70-138f-42ef-a4a6-7635043d9759",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
},
"equipment_family_id": "85e2bfb2-f41d-47f4-86e9-646a86790f27",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e677b87-269d-44f8-b152-4eb31e9c77ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9c372d9e-2871-4e4b-bfa7-9c1b0d7ad562",
"_parent_code": "sample string 6",
"sales_organization_id": "06854c35-f345-4493-83c3-424fba286265",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
},
"date_in_production_since": "2026-03-04T12:40:48.8534843+00:00",
"date_out_of_production_since": "2026-03-04T12:40:48.8534843+00:00",
"date_end_support": "2026-03-04T12:40:48.8534843+00:00",
"sales_organization_id": "11ecb459-406b-4c99-b107-fc72d12bba00",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+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-03-04T12:40:48.8534843+00:00"
},
"project_status_id": "df5cd339-4fe4-4b20-b47d-3a17c7eacd91",
"project_status_code": "sample string 10",
"project_status": {
"id": "7a5e5a8d-bed8-4af8-99f2-1692c90596dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f7f82f4d-344e-4b88-a354-fdad507e5863",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
},
"company_id": "8aea4e92-4903-41ab-9c50-5bd1e2784f87",
"company_code": "sample string 12",
"db_address_id": "23f2ed35-9cdc-4fd0-b8bd-6e2665dba6e2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c69fcc86-0d99-49ad-bcbc-822783b1bcff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9aa5cb9d-5589-4a60-8191-2408ebf84594",
"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-03-04T12:40:48.8534843+00:00",
"date_create": "2026-03-04T12:40:48.8534843+00:00",
"date_update": "2026-03-04T12:40:48.8534843+00:00",
"updated_by_user_id": "2ef60cd9-e93f-433f-a046-723c21a9f2fa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-04T12:40:48.8534843+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-03-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-04T12:40:48.8534843+00:00",
"date_last_job": "2026-03-04T12:40:48.8534843+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-04T12:40:48.8534843+00:00",
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00",
"is_mobile_installation": true
},
"job_type_id": "410b5523-ab38-43ee-8548-9c32e4556d77",
"job_type_code": "sample string 7",
"job_type": {
"id": "9c850a52-5f41-42cf-972f-046f22bebc5a",
"name": "sample string 2",
"sales_organization_id": "9b5076f6-2755-43fd-9127-d0988a90efea",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00",
"code": "sample string 7"
},
"job_priority_id": "9d7a0531-9743-4896-9828-5838599835e3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "25dbce9d-b7e7-4898-a515-eb6feb804fe3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "339840e1-226f-4ec4-bad2-d5135bc6f9fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
},
"job_status_id": "68758969-0a3e-4ffd-a9dc-51111bb92b25",
"job_status_code": "sample string 11",
"db_address_id": "24f23dad-2e71-41b8-bdd5-7e72d39cb0c0",
"contact_id": "54b3c8c6-b7b4-4293-a7de-fe9e70b96216",
"requested_by_company_id": "90919c74-286e-467d-b5f4-fb0c0b33a61e",
"requested_by_contact_id": "8f9c13cb-a55e-4b2f-851b-13ff8e82bfb7",
"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-03-04T12:40:48.8534843+00:00",
"due_date": "2026-03-04T12:40:48.8534843+00:00",
"date_create": "2026-03-04T12:40:48.8534843+00:00",
"date_update": "2026-03-04T12:40:48.8534843+00:00",
"date_closed": "2026-03-04T12:40:48.8534843+00:00",
"suggested_user_id": "f4c17288-1bb8-4259-82ca-90e880059e4a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fb3c7cde-90b3-4415-be52-85ceb2f6f57f",
"db_language_id": "98640d2c-f789-4186-8abc-bfe46173c5ae",
"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-03-04T12:40:48.8534843+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "64d96933-7465-4a6d-988e-7a1468ad839c",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5925154b-8f1b-4961-bb25-c716eb24bec1",
"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": "61c0bdd3-6e11-45e6-afa2-ad615f02ad59",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1a834cf0-92a5-424c-a55a-88013461f979"
},
"suggested_date_start": "2026-03-04T12:40:48.8534843+00:00",
"skill_id": "7e0a4d00-090e-4406-9dee-25d9d4d4a192",
"skill_code": "sample string 32",
"skill": {
"id": "b9cc9292-594c-4410-a00e-b112b6840838",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b53b033e-2c2b-4d24-be15-3725aa5aa797",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "455549c8-3a75-4dc0-ac48-ff6bf37fc636",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f70c21fe-c91a-4d76-a17d-d748e46d3acc",
"db_currency_id": "c65b5b3d-9edd-4a8f-93de-8462fe4363ed",
"db_language_id": "b4e72e04-9748-4e8f-8f1d-858da16a8974",
"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-03-04T12:40:48.8534843+00:00"
},
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fa6af931-5dcf-475a-9782-ea022975ac16",
"date_reported_by_company": "2026-03-04T12:40:48.8534843+00:00",
"id2": 36,
"company_id": "8e96a133-36fb-4ba8-8a7d-f10bf5fe5991",
"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": "ebc42f75-4a61-40a4-a6af-5cd81b5becce",
"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-03-04T12:40:48.8534843+00:00"
},
"work_instruction_details_id": "6a1cbfae-9906-4fe3-b49e-a012ffc15257",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0aaabc86-acbb-4fc9-bed2-2f6e541e0b7a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ae3cd590-3f32-48d7-80ae-e5120601f4b1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-04T12:40:48.8534843+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": "8b93baf4-b751-4756-87a4-9ec24c3d7f26",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-04T12:40:48.8534843+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.