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": "197b4858-17e5-41b7-871f-b28dfe1e527e",
"jobs_id": "1de6ddf3-2fc0-4a52-a6b2-055e277fa60e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2afaf9c9-4061-4cbd-8b36-a346b43a44fa",
"_parent_id": "9f926ab5-ec1f-4a11-86c5-9698bf8874d5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "853949d5-19e2-4c17-ad0f-97ac684d8a38",
"project_reference_back_office": "sample string 5",
"project": {
"id": "51517a5a-2b73-4237-9eb9-54e02156ba58",
"_parent_id": "05c660d5-b9cb-48df-9a04-7bd5be8d1171",
"root_parent_id": "c152644d-62b1-492b-97b6-29d380abf6b3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f224d0e8-189b-4b4c-8ff5-e1085333d0fc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "246895d4-5789-4676-bc1b-564ef2fbab1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "57c3f63d-9349-4186-ac0d-ea89290371a8",
"_parent_code": "sample string 6",
"sales_organization_id": "d702a76a-d596-481c-a962-40638cecc814",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
},
"equipment_model_id": "cca0f555-d14b-4a25-accb-605641631190",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "852777e5-3ba0-4937-8aec-c73b37a0346c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8306d547-f80a-4818-8ece-e67057de88a4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fcb03957-691a-4afe-b3c5-030e54b43f15",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "54e57137-1f1e-4b66-ac0e-17f4ddaecfb5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
},
"equipment_family_id": "4cae78bd-7605-44a4-ad18-a4a06f9f6ff8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "246895d4-5789-4676-bc1b-564ef2fbab1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "57c3f63d-9349-4186-ac0d-ea89290371a8",
"_parent_code": "sample string 6",
"sales_organization_id": "d702a76a-d596-481c-a962-40638cecc814",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
},
"date_in_production_since": "2026-02-25T03:44:41.9588802+00:00",
"date_out_of_production_since": "2026-02-25T03:44:41.9588802+00:00",
"date_end_support": "2026-02-25T03:44:41.9588802+00:00",
"sales_organization_id": "a54db210-7eb9-444f-b4b1-7044bef7ce3b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+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-25T03:44:41.9588802+00:00"
},
"project_status_id": "68d646b2-1828-4158-8b57-271806238d66",
"project_status_code": "sample string 10",
"project_status": {
"id": "69cc6cdc-1653-4ef0-ac0f-0aef48a52a39",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b56facf3-40a9-434b-a15b-6f5a087665d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
},
"company_id": "5186ae8f-e19d-46b2-ba7f-f2c8f21828ab",
"company_code": "sample string 12",
"db_address_id": "0734f3c1-6324-40c3-8c51-cd03baf09fb5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cfb967e6-d6c5-4b95-973f-b53eaed3e781",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a9a4309f-8cb7-40de-bc03-d953b5e868c4",
"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-25T03:44:41.9588802+00:00",
"date_create": "2026-02-25T03:44:41.9588802+00:00",
"date_update": "2026-02-25T03:44:41.9588802+00:00",
"updated_by_user_id": "857917d2-a4a0-4008-a0f5-8e8293e780df",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T03:44:41.9588802+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-25T03:44:41.9588802+00:00",
"date_last_job": "2026-02-25T03:44:41.9588802+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T03:44:41.9588802+00:00",
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00",
"is_mobile_installation": true
},
"job_type_id": "56b77307-af06-473d-8050-f24f57054cd0",
"job_type_code": "sample string 7",
"job_type": {
"id": "b85dec07-463b-41d2-ada9-6027eaa5ec63",
"name": "sample string 2",
"sales_organization_id": "55f91937-0032-4449-9dc9-b01a47e0be3c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00",
"code": "sample string 7"
},
"job_priority_id": "5ef1d672-039d-46e8-983b-661476a7b15b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "51a7b8ef-6499-4f5a-9c93-1b1505357b01",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d36ed4e9-34b0-4aeb-82f1-92f815004361",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
},
"job_status_id": "28f900df-67b6-47bf-9be7-4734026f231f",
"job_status_code": "sample string 11",
"db_address_id": "08cf1d19-ee16-4207-8cc1-e22a38356d82",
"contact_id": "ed727fad-32c9-41b9-b89e-0a11e8a3bd8d",
"requested_by_company_id": "d08e9cd3-abe7-4b9e-89fd-92120f867de9",
"requested_by_contact_id": "6e6d0142-3148-4baf-bbcf-cc6624255126",
"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-25T03:44:41.9588802+00:00",
"due_date": "2026-02-25T03:44:41.9588802+00:00",
"date_create": "2026-02-25T03:44:41.9588802+00:00",
"date_update": "2026-02-25T03:44:41.9588802+00:00",
"date_closed": "2026-02-25T03:44:41.9588802+00:00",
"suggested_user_id": "2c3e8373-b548-4f57-a5ca-95b5993706a7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "64d87a1c-3902-4e5b-99ed-026674dfe594",
"db_language_id": "7d7b23bf-1833-4e73-ba3f-86d99d435e8a",
"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-25T03:44:41.9588802+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b53f31b3-cd9f-4f7e-8fd8-5f1708c20d06",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6bd89877-0473-4035-b57d-ae47ed412af5",
"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": "9e3dc597-274c-4ecf-a77a-2bcd58140ce1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "518bb4bd-504b-4032-a45b-9814501ae936"
},
"suggested_date_start": "2026-02-25T03:44:41.9588802+00:00",
"skill_id": "c0e8ee43-3986-4ea8-abc2-0f68b8b0be28",
"skill_code": "sample string 32",
"skill": {
"id": "9bda6852-8170-4a93-b84f-7589f83ae5a3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "66201947-68d7-4195-963b-f1d828c7064f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a842180-e23f-4102-9ce0-d1fab48880a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f65a7ffb-6740-4000-be11-b230bfd4a0c4",
"db_currency_id": "1302a4aa-46a2-4458-adad-f37170d6830b",
"db_language_id": "73e50014-625b-4004-8e56-1e927854cc46",
"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-25T03:44:41.9588802+00:00"
},
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d86692cb-9443-41fb-b324-70f2f2b1fb2b",
"date_reported_by_company": "2026-02-25T03:44:41.9588802+00:00",
"id2": 36,
"company_id": "e476d75c-2918-49f1-8c9b-600ecdd70c77",
"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": "ab4d22b9-edf8-43d6-8589-3644bfc0efed",
"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-25T03:44:41.9588802+00:00"
},
"work_instruction_details_id": "8d9d36e8-07db-4ec0-bbf5-bc3932d36154",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "93a9b0c2-8dfb-4cf2-b396-1a3556269600",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "797bca54-29fa-45d3-b85a-c51f3b3a85ae",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T03:44:41.9588802+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": "ff737019-c6d8-4c41-8c07-f9f91631031c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T03:44:41.9588802+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.