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": "f77835bf-274c-4d01-9f61-9a652d0fe0ee",
"jobs_id": "2c4d4306-f54a-49c2-90ea-dc7fdbc6beef",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "76c442e3-b3b5-4df4-aa02-18f5398b053c",
"_parent_id": "73b29fec-9821-42fb-aa97-1904b67a0cd7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e6f8520d-27c5-49bd-906f-4b72f7553fe4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f1965a75-df3f-4f9b-8804-f746551fb703",
"_parent_id": "ab27fce0-f960-43c8-8448-1abeab5b1241",
"root_parent_id": "4f6e75b7-9e12-451e-a226-19d5a2e93120",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "195fac72-19f0-4635-866b-79aed81ee98e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1bf60c4d-500f-4a3e-b880-99be5935ed5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b1466056-6e3b-48f6-a1bd-c747d9f1cc76",
"_parent_code": "sample string 6",
"sales_organization_id": "cc2f1545-3868-41a1-86c5-0716d1b1c53d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
},
"equipment_model_id": "95ea7c0a-0ef4-47dc-a362-1d6e62c50ed3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "68fe7c41-7434-4223-b764-876b33f1111d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9d1d0e5b-6efe-4a45-a9bc-5fa921e8dbac",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "33a3b82a-8667-4e9c-8d87-c856883cd916",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9419eb51-06b7-4c8f-a43b-bac415079a83",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
},
"equipment_family_id": "da3de183-43b3-4628-8602-99d44eaaeedd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1bf60c4d-500f-4a3e-b880-99be5935ed5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b1466056-6e3b-48f6-a1bd-c747d9f1cc76",
"_parent_code": "sample string 6",
"sales_organization_id": "cc2f1545-3868-41a1-86c5-0716d1b1c53d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
},
"date_in_production_since": "2026-07-14T10:59:12.780001+00:00",
"date_out_of_production_since": "2026-07-14T10:59:12.780001+00:00",
"date_end_support": "2026-07-14T10:59:12.780001+00:00",
"sales_organization_id": "a200b269-af5e-44a5-a9b8-404298f7f8f1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+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-07-14T10:59:12.780001+00:00"
},
"project_status_id": "1f7e983a-4da2-4078-9b0e-4f9d7ebe0c38",
"project_status_code": "sample string 10",
"project_status": {
"id": "582dd2e0-d364-4b97-8198-74233b0e21ab",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "eb653d40-b868-49b3-b4a5-9c1e1bcde65e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
},
"company_id": "ac5676ff-620c-45a9-91f3-9834479fe74b",
"company_code": "sample string 12",
"db_address_id": "83419922-0e55-4e83-b3f4-9f5fcb90addf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e1b866e8-d9b8-416c-93c7-7f964d1c3598",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ea483236-19f7-4774-8589-6978bdbd3d29",
"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-07-14T10:59:12.780001+00:00",
"date_create": "2026-07-14T10:59:12.780001+00:00",
"date_update": "2026-07-14T10:59:12.780001+00:00",
"updated_by_user_id": "57cdcc50-2ce4-4afa-8cdf-ceb23d854bce",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-14T10:59:12.780001+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-07-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-14T10:59:12.780001+00:00",
"date_last_job": "2026-07-14T10:59:12.780001+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-14T10:59:12.780001+00:00",
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00",
"is_mobile_installation": true
},
"job_type_id": "321ebf6f-1bf3-4e94-b06e-a94bcb056e9c",
"job_type_code": "sample string 7",
"job_type": {
"id": "d250c1f9-8cb1-44b2-bf0c-3cf5c3b3c1cb",
"name": "sample string 2",
"sales_organization_id": "7b7f77fd-79a8-4d76-bbe1-a6c1687fea7e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00",
"code": "sample string 7"
},
"job_priority_id": "c5b115a9-0624-419e-9118-8794c49b0a41",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f41cb54b-b6d6-4783-ba6d-9a10f848b0b1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5a9a9ed4-2a52-4b14-9f31-574edc9faffc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
},
"job_status_id": "1da9cacc-00ca-48a6-9a68-4abc6c2847c7",
"job_status_code": "sample string 11",
"db_address_id": "7b0bf313-a2e4-4469-859c-e14207e89e12",
"contact_id": "280be9fd-41c7-4e37-b725-c5a44de7af86",
"requested_by_company_id": "e48aa3bb-09f9-4289-938e-f6483c2059eb",
"requested_by_contact_id": "eed46666-6061-46ab-a2cc-0f7cc44a881a",
"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-07-14T10:59:12.780001+00:00",
"due_date": "2026-07-14T10:59:12.780001+00:00",
"date_create": "2026-07-14T10:59:12.780001+00:00",
"date_update": "2026-07-14T10:59:12.780001+00:00",
"date_closed": "2026-07-14T10:59:12.780001+00:00",
"suggested_user_id": "626e77e7-44b9-4432-8661-4ddff5faa8fa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "790e2f11-703c-47a0-8267-14efc0064ad0",
"db_language_id": "349c8393-f2c0-4a4c-9d5b-63a0458d05d5",
"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-07-14T10:59:12.780001+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d23a2721-0ffd-4eb4-81b4-918601b075da",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "139cc4ca-0257-4164-9b78-ddfc0b3a292f",
"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": "40afff6c-7282-447a-a45c-87cfb40ec2b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e7925990-4354-47f6-94b6-aad326b338d6"
},
"suggested_date_start": "2026-07-14T10:59:12.780001+00:00",
"skill_id": "39abaa3d-24cb-4475-9eb5-6ca2ab506d4f",
"skill_code": "sample string 32",
"skill": {
"id": "6c152097-ff7c-43cd-af74-8185cb633b45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3beb3606-b864-4e97-88c2-9862976ed418",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c68d15f0-890c-498b-b235-e83927f97892",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28d8ca0c-1514-4f85-b128-b7c35557e98e",
"db_currency_id": "16e162c1-d9b7-46bf-bc99-3519b513eeb2",
"db_language_id": "6a69003b-5d6c-4908-a276-85d736f9a10b",
"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-07-14T10:59:12.780001+00:00"
},
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ac167e6f-844a-44ac-a7fc-390d00b885b5",
"date_reported_by_company": "2026-07-14T10:59:12.780001+00:00",
"id2": 36,
"company_id": "a2a7579c-b927-4eb7-8f4d-e1c0101de3a8",
"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": "0a817e01-892a-44c9-bf47-a7b4259cc89a",
"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-07-14T10:59:12.780001+00:00"
},
"work_instruction_details_id": "0beab306-3b7c-485e-9a8a-cc18ff236109",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8acfb4a3-4f42-40e8-bc6f-a6e91593e3c7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e89f49dd-b853-4e96-9717-c126f1554d9b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-14T10:59:12.780001+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": "02003d43-fc6d-4ee0-8f5d-432991e7e075",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-14T10:59:12.780001+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.