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": "e4a25948-7cfa-4e26-bdef-0c6a56284bda",
"jobs_id": "10297be3-39de-435b-85ea-22e0d85461fe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a9d28d9d-af2b-4557-8434-699d1eac6359",
"_parent_id": "f0e6cebb-d5c4-4d47-972d-d944b1a9409c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6d148a1c-ae94-4075-b8fd-2cb627e61be9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bea332cc-755f-4ea3-8881-01caa8db93cf",
"_parent_id": "e56d7c05-207f-46c7-827d-5090a4759045",
"root_parent_id": "fed5f190-0365-400f-a0d6-1b3c43b964ff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0a497742-1b2b-45b3-b763-b1ec19077f49",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3082db87-54ff-4256-9837-0ca7bc7681b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "88873ee4-0a78-4e9a-9a9e-015cb1cf8496",
"_parent_code": "sample string 6",
"sales_organization_id": "c8089076-12f6-44a5-90fc-fbcee8a0ab48",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"modified_dateutc": "2026-11-11T16:13:00.0112794+00:00"
},
"equipment_model_id": "8c248c83-6558-47ae-be26-6224d124c75c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "08d3fb89-3a39-4822-84d2-31600d08d116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4e8d99c8-4f4a-4bb0-bd8c-2e95d3e71026",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8f478d9b-1134-46bc-bd7d-f228951262b0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f95e9218-67c2-47ab-9a1b-78bfd781c987",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"modified_dateutc": "2026-11-11T16:13:00.0112794+00:00"
},
"equipment_family_id": "86e6001a-1f6e-4cf0-8a91-3a5685a8ba63",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3082db87-54ff-4256-9837-0ca7bc7681b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "88873ee4-0a78-4e9a-9a9e-015cb1cf8496",
"_parent_code": "sample string 6",
"sales_organization_id": "c8089076-12f6-44a5-90fc-fbcee8a0ab48",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"modified_dateutc": "2026-11-11T16:13:00.0112794+00:00"
},
"date_in_production_since": "2026-11-11T16:13:00.0112794+00:00",
"date_out_of_production_since": "2026-11-11T16:13:00.0112794+00:00",
"date_end_support": "2026-11-11T16:13:00.0112794+00:00",
"sales_organization_id": "8e55ae22-92a4-40f3-adeb-943b6c19a17b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+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-11-11T16:13:00.0211968+00:00"
},
"project_status_id": "00192807-bdad-4884-ab82-2394656c4b3a",
"project_status_code": "sample string 10",
"project_status": {
"id": "faf1c8c1-4d15-4b7d-a4f7-ede982b398f0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "651c9f1b-9d70-4d6c-92fb-1100103e3c9f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-11T16:13:00.0211968+00:00"
},
"company_id": "5fec4fb9-fe1b-4be1-a5b8-c6a84e6aa7b4",
"company_code": "sample string 12",
"db_address_id": "ed3ea515-2327-4139-adb8-9d5d9f23faac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "17509e10-1e61-4a8d-be1b-e5172583306e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bfe48805-6c3c-4922-bf4a-bcf4dc8b41eb",
"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-11-11T16:13:00.0211968+00:00",
"date_create": "2026-11-11T16:13:00.0211968+00:00",
"date_update": "2026-11-11T16:13:00.0211968+00:00",
"updated_by_user_id": "25805249-ba6b-46ca-aba9-d0eea3f541d9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-11T16:13:00.0211968+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-11-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-11T16:13:00.0211968+00:00",
"date_last_job": "2026-11-11T16:13:00.0211968+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-11T16:13:00.0211968+00:00",
"modified_dateutc": "2026-11-11T16:13:00.0211968+00:00",
"is_mobile_installation": true
},
"job_type_id": "63f1125e-6cf8-42c3-be05-59930562a607",
"job_type_code": "sample string 7",
"job_type": {
"id": "1352deec-fb6f-414a-accd-32137bba9774",
"name": "sample string 2",
"sales_organization_id": "1e844106-ed07-40cd-81d0-9ed7ae1efc4e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-11T16:13:00.0211968+00:00",
"code": "sample string 7"
},
"job_priority_id": "262297bf-4c1a-4d16-814e-1d2053cc4f8f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5314cadc-8a25-44e4-8f12-04b8acc45f6a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a05de742-c1b9-4000-bfa6-301f1a17e3bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-11T16:13:00.0211968+00:00"
},
"job_status_id": "f5c40800-7442-46ba-9611-e6518714816e",
"job_status_code": "sample string 11",
"db_address_id": "793fd139-fe3d-4966-915d-96129bdfaf03",
"contact_id": "ecd3c598-23fb-4bb5-8cdc-05ee63a327ec",
"requested_by_company_id": "24e3e1c7-19f1-48c8-ab2d-73483dcf0c28",
"requested_by_contact_id": "8efb03b9-8fe5-48db-93fd-674cd04f88c4",
"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-11-11T16:13:00.0211968+00:00",
"due_date": "2026-11-11T16:13:00.0211968+00:00",
"date_create": "2026-11-11T16:13:00.0211968+00:00",
"date_update": "2026-11-11T16:13:00.0211968+00:00",
"date_closed": "2026-11-11T16:13:00.0211968+00:00",
"suggested_user_id": "daf4f69a-e113-447f-8d5c-5bb908b70feb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "44c6eb28-a80e-402f-bfff-57cd8856a0c5",
"db_language_id": "77d85ae4-80b4-4ac9-8a61-49251324a9db",
"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-11-11T16:13:00.0211968+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1cbd08d5-693f-4cd1-9ab7-fa7a5a4a4df4",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f6c1cab0-0581-4fa0-8656-26ef2fd49a98",
"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": "dfd568c6-8e7c-48d3-b986-230e9113cd3c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-11T16:13:00.0211968+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "da3b0148-0bd4-4864-ac8c-57dee7fa3295"
},
"suggested_date_start": "2026-11-11T16:13:00.0211968+00:00",
"skill_id": "84fe6cb0-5410-4eba-907a-ac6cdaa6aebf",
"skill_code": "sample string 32",
"skill": {
"id": "0bc01ecc-8fa0-4c75-b488-089f2a23be62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ad2af92f-bef5-45e6-a1da-47b22847a76f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3427b5d3-2735-474f-b627-1ebdad8f4288",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7601f18-733f-4968-b3a4-e6e33cb7925e",
"db_currency_id": "f0d76135-1586-4059-aac0-670737adc051",
"db_language_id": "8162822b-0f4d-4960-bd0d-cbaafad03a68",
"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-11-11T16:13:00.0112794+00:00"
},
"modified_dateutc": "2026-11-11T16:13:00.0211968+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "69fe29a2-ff3f-4f36-a0f0-adf1d934867e",
"date_reported_by_company": "2026-11-11T16:13:00.0211968+00:00",
"id2": 36,
"company_id": "182ea65c-c808-4b46-ab5b-08b3b6283506",
"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": "a558fb0f-f316-418e-a8af-2f464da12793",
"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-11-11T16:13:00.0211968+00:00"
},
"work_instruction_details_id": "247f8c72-3ac2-46ad-9e9d-c2b7eb3d6062",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "614a8006-7d90-46c2-ae2d-0029a456b928",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a97c52b6-1cf8-445e-b19e-77bcd464e833",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-11T16:13:00.0211968+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": "06260d1d-fe46-4b59-9402-734f02b4419f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-11T16:13:00.052425+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.