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": "1edb671e-83e7-4870-97e4-eb4990622a69",
"jobs_id": "1047732d-ddba-4318-a38b-41e3c6431708",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "98a06eb7-d3a9-4461-b9d6-be783f7c3e43",
"_parent_id": "c869cff3-1b5c-49ff-89e8-069ce78889fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79d7a4fe-c6fb-4e9b-9784-2b554978c5a2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a5ebcc0d-67d0-470d-9d2a-e29c1cb199d5",
"_parent_id": "7a13f6aa-eb48-4398-a2be-8c2f8345652c",
"root_parent_id": "3b245ec9-134b-45f3-9991-0ce1096098db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "27421c71-789f-4f9c-a4b0-057b76d063e0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e13e279f-09a4-4943-8405-c3997d18ccb1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9939e57b-a689-48fd-ae72-aa4477906605",
"_parent_code": "sample string 6",
"sales_organization_id": "703e6926-9884-4fa6-8717-1b9de598135e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
},
"equipment_model_id": "b34f57c7-b5e2-4b4e-90a6-14f9fb01eb36",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "965b6ed9-b56b-48ac-b5c3-4f172b79cdf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d7f4aaa5-25bf-4e05-8e74-b06eb0c39eab",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5b4260db-6702-46d3-9367-8ded623492f9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ff6ebbcf-abf1-49c2-b4b9-310f1307238e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
},
"equipment_family_id": "1af244f1-db6e-42a0-a764-ebae90ab42ac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e13e279f-09a4-4943-8405-c3997d18ccb1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9939e57b-a689-48fd-ae72-aa4477906605",
"_parent_code": "sample string 6",
"sales_organization_id": "703e6926-9884-4fa6-8717-1b9de598135e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
},
"date_in_production_since": "2026-05-01T06:29:42.4301235+00:00",
"date_out_of_production_since": "2026-05-01T06:29:42.4301235+00:00",
"date_end_support": "2026-05-01T06:29:42.4301235+00:00",
"sales_organization_id": "0b3d66a6-8025-4a3b-b537-9c6b914cc0bb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+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-05-01T06:29:42.4301235+00:00"
},
"project_status_id": "865f6bf6-f533-4a8a-a5de-8a40938d0ee6",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb2bdda8-8979-415c-b3ff-656a88c04df3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c597e62f-009e-4736-9cb4-2b39f3380440",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
},
"company_id": "cb374083-b13b-441a-a5e8-2ea1694b86a6",
"company_code": "sample string 12",
"db_address_id": "7c86ebf8-005e-4dca-91b2-f89f7c395184",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "016eadfe-5588-4d4f-9b32-848bfc3abe2b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c4cb4cd3-8464-4a95-ac03-db2d1dc82c5b",
"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-05-01T06:29:42.4301235+00:00",
"date_create": "2026-05-01T06:29:42.4301235+00:00",
"date_update": "2026-05-01T06:29:42.4301235+00:00",
"updated_by_user_id": "7ba8ea13-2cdf-4f28-929f-affed9743bd4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-01T06:29:42.4301235+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-05-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-01T06:29:42.4301235+00:00",
"date_last_job": "2026-05-01T06:29:42.4301235+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-01T06:29:42.4301235+00:00",
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00",
"is_mobile_installation": true
},
"job_type_id": "7d7852e9-aba4-4c84-a841-8bf581ae1fce",
"job_type_code": "sample string 7",
"job_type": {
"id": "9584d99a-eef3-44ee-9ec2-9852990b3cb7",
"name": "sample string 2",
"sales_organization_id": "7e1e608a-c6bb-4ba4-af5f-9423c817e01e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00",
"code": "sample string 7"
},
"job_priority_id": "5ce017bf-caf4-4729-80f0-cd769f532cef",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4b344865-80a8-4a99-9d96-c27312956d42",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5234bc5f-fff7-40c5-afc3-da128377536c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
},
"job_status_id": "7f88224e-1181-49ae-8a0b-6778b5407ff7",
"job_status_code": "sample string 11",
"db_address_id": "9e1156a7-ae18-4fb5-b05b-ad51617d1172",
"contact_id": "af43c3d2-64ef-4dac-adb9-b008d6175463",
"requested_by_company_id": "24cc0ea6-4781-426e-aeec-6d2444697165",
"requested_by_contact_id": "e79d4003-e993-4e5e-90c1-18419653b9d6",
"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-05-01T06:29:42.4301235+00:00",
"due_date": "2026-05-01T06:29:42.4301235+00:00",
"date_create": "2026-05-01T06:29:42.4301235+00:00",
"date_update": "2026-05-01T06:29:42.4301235+00:00",
"date_closed": "2026-05-01T06:29:42.4301235+00:00",
"suggested_user_id": "a888b9c7-6b45-4209-89b0-2be2c865079b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ba68a63a-2d10-4ee2-93bc-cd5ae800aa80",
"db_language_id": "684cfc46-fb15-43b4-9143-4fc7e22b5a6e",
"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-05-01T06:29:42.4301235+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "869ddef4-d2ec-4b51-8f66-ed4fff73c099",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c62d7b39-8c51-4ddf-a524-aa57ddc034cf",
"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": "52a7c87f-0baa-4d69-b039-a9d0929a7d56",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a6f42d8e-b86b-4f74-958e-7361066ba684"
},
"suggested_date_start": "2026-05-01T06:29:42.4301235+00:00",
"skill_id": "09447008-7603-47f7-809f-b5300ee38aa7",
"skill_code": "sample string 32",
"skill": {
"id": "8395a1f4-5cab-474c-8979-3b1ff3031dc5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7989b42b-915c-4bea-8369-fa1a6c1c8226",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0e675b3-2a0a-4d3f-8bd0-528520086ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76068775-835b-487c-8964-612405289b00",
"db_currency_id": "fc38e3f3-21af-4de5-9860-325f330ecbb2",
"db_language_id": "6efd1453-a9f6-45ab-a91b-0d74e8b5d63b",
"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-05-01T06:29:42.4301235+00:00"
},
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9edb2f31-6100-4e76-9781-f7cbea8fe82f",
"date_reported_by_company": "2026-05-01T06:29:42.4301235+00:00",
"id2": 36,
"company_id": "97bd3579-391d-4f1a-b882-15859f1d62d9",
"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": "a989ad3a-bf87-4834-bf36-65eb4752c71c",
"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-05-01T06:29:42.4301235+00:00"
},
"work_instruction_details_id": "0bf4228b-d536-4e38-bc9c-cbc30427f35d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "da4656e7-4645-4603-9b38-95639a1a4397",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "17e72161-fc83-488c-a64d-dc3d67d066d6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-01T06:29:42.4301235+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": "765f1198-bb58-46e4-8807-d901245d7491",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-01T06:29:42.4301235+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.