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": "c79f3afb-8842-49de-95b3-55a4ca8c39dc",
"jobs_id": "6b10d35f-e37d-4aa0-bd7b-38cd9acc28c0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d648cd7e-393d-4f4e-b012-deb321bf985d",
"_parent_id": "92ae7a7d-6b69-495c-b4a2-3e0d486086af",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a26013c7-3b6c-4123-a56c-fc44cae79d0c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8ed1d87e-1866-40c9-9167-feb0ebe6ca96",
"_parent_id": "244611a3-91b1-425e-a937-648bdce657d2",
"root_parent_id": "c27494ec-0b18-4619-a0ad-261fd84d683d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c3f8ab8f-fa84-4091-88ef-5fd6d72a57c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eaac7cae-42bf-4a83-805e-830fde3585eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27359531-e4fa-48e9-889f-948514984728",
"_parent_code": "sample string 6",
"sales_organization_id": "38df2058-bb31-4aa2-b718-022c7432152e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
},
"equipment_model_id": "d38d8588-8f15-46eb-b1ec-44f03e06c4e5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "956133e7-90c9-4e41-845e-7f61edcb40f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "54c0c031-01bb-415c-998a-80cbc08dfef1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eaf6b1ae-a212-42f3-910f-5ab77ad66c6f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "04adb0d5-e645-4d9f-b674-5cf3b9454d9b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
},
"equipment_family_id": "2c3bf654-676f-4826-94a2-133c71901944",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eaac7cae-42bf-4a83-805e-830fde3585eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27359531-e4fa-48e9-889f-948514984728",
"_parent_code": "sample string 6",
"sales_organization_id": "38df2058-bb31-4aa2-b718-022c7432152e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
},
"date_in_production_since": "2026-02-07T06:28:25.4757309+00:00",
"date_out_of_production_since": "2026-02-07T06:28:25.4757309+00:00",
"date_end_support": "2026-02-07T06:28:25.4757309+00:00",
"sales_organization_id": "ded6d3c1-7d83-4e58-ac24-1991e0457fcb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+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-07T06:28:25.4757309+00:00"
},
"project_status_id": "d88cc580-3e83-4c0d-abc1-825d27708ea5",
"project_status_code": "sample string 10",
"project_status": {
"id": "60504ae5-ed36-4acb-8e9a-c05c8347ef74",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "46cde83e-b02f-4feb-ab47-32a231a60516",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
},
"company_id": "7ca0ef00-aed4-41ec-9d38-548c96393312",
"company_code": "sample string 12",
"db_address_id": "a4b1061e-f711-4b85-8e33-07e28fde5201",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "abfd5052-3d88-4a03-8d2a-1c30e3ea477a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "59a0af77-a09e-4425-b92d-d86b47ff5af7",
"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-07T06:28:25.4757309+00:00",
"date_create": "2026-02-07T06:28:25.4757309+00:00",
"date_update": "2026-02-07T06:28:25.4757309+00:00",
"updated_by_user_id": "ace29392-287d-4ecc-b95d-b7aa0a787593",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-07T06:28:25.4757309+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-07T06:28:25.4757309+00:00",
"date_last_job": "2026-02-07T06:28:25.4757309+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-07T06:28:25.4757309+00:00",
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00",
"is_mobile_installation": true
},
"job_type_id": "bc310d21-d029-432f-a99f-d7c41baa6ae8",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d3f8a02-ee34-4286-95e5-f3922652e3e0",
"name": "sample string 2",
"sales_organization_id": "66ab2855-fb83-417d-9fa9-a18c0f8371df",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00",
"code": "sample string 7"
},
"job_priority_id": "23002c29-efa1-4ce7-b55c-6e569e6a25f9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "39cc57ad-453b-4997-aeaf-ecc31ff638ad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f857d47e-e5b3-4874-95d5-f9a140b53128",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
},
"job_status_id": "656d3e75-b246-4bc0-9149-552f256103f1",
"job_status_code": "sample string 11",
"db_address_id": "fe05aa6a-658c-4f52-b6df-0d42781ba745",
"contact_id": "d2bc03d6-d78a-4da7-9940-7dfa74be9a0e",
"requested_by_company_id": "407c372b-696b-4d20-9e37-7f4f3dbcc3dc",
"requested_by_contact_id": "c441ebc3-fd73-44f7-92df-a3762ba1b678",
"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-07T06:28:25.4757309+00:00",
"due_date": "2026-02-07T06:28:25.4757309+00:00",
"date_create": "2026-02-07T06:28:25.4757309+00:00",
"date_update": "2026-02-07T06:28:25.4757309+00:00",
"date_closed": "2026-02-07T06:28:25.4757309+00:00",
"suggested_user_id": "8bcc67b7-7358-4c82-8938-00b3230c8eaf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "35bde5a3-aa20-4c64-b2bb-75b20bada3fd",
"db_language_id": "f7c77154-fc22-4217-8cfc-64c11050adbd",
"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-07T06:28:25.4757309+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "149cde4e-dfcc-4c9b-905f-bbe3a23d7aba",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e12f7dc8-fb64-4bd1-85ed-bd5a03976e2f",
"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": "c3379e93-db4d-46c3-9721-ac5e3b7ccbc0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e09facb5-afc7-4aa4-97c8-90773697549e"
},
"suggested_date_start": "2026-02-07T06:28:25.4757309+00:00",
"skill_id": "69a8fcc1-01fa-4113-978c-23660f22bf86",
"skill_code": "sample string 32",
"skill": {
"id": "262cbd5e-160e-4696-b499-3098971288ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8bd813de-482a-40f8-acd7-3568ce4d59d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "233ad70b-7d76-4f99-b8e7-d6543710c0b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b481036-9263-4b35-9616-b443b4b2db5e",
"db_currency_id": "c48f404d-43f8-4811-916f-6f0f0b1c101c",
"db_language_id": "9124c8aa-d22d-4fa2-984f-cab5922f06bb",
"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-07T06:28:25.4757309+00:00"
},
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0fcfe57b-1961-4beb-a0bf-dd5d62726c87",
"date_reported_by_company": "2026-02-07T06:28:25.4757309+00:00",
"id2": 36,
"company_id": "70f77f03-548c-46ac-9e5d-f482ea6deabd",
"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": "64ae579b-7fe9-4a10-be7c-1b392f0ff31e",
"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-07T06:28:25.4757309+00:00"
},
"work_instruction_details_id": "24ae7415-c865-42fe-8860-104fe13d27b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bc544016-104e-448c-9e26-8a7f571e63dc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4f1221b5-fb07-452f-aa32-b2bd68539ac9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-07T06:28:25.4757309+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": "418de753-347e-42bc-ba15-e340a3634d56",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-07T06:28:25.4757309+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.