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": "00c0f373-3bf5-460c-825a-fc5837a355fc",
"jobs_id": "f7cf9dc1-b279-41c7-bc05-53aa0c80171a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7445d563-27ab-4dcf-bf5e-04c252dbf78e",
"_parent_id": "fffeb724-c471-422b-9991-8d8ced0484f8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0a2bbedd-7091-41e0-b97e-b350e1de9733",
"project_reference_back_office": "sample string 5",
"project": {
"id": "065496c1-c3aa-442e-847c-93d258201b31",
"_parent_id": "684513a0-ff34-4d20-8dce-0df5c2555a3b",
"root_parent_id": "4edd69ab-e485-4bd8-b710-1e60979c14a6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "791ea4d1-2218-412f-9e03-6b3ccf3735e1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2705cb44-a41c-4e1b-b784-370cf2ccd1c3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "783a07a8-f8bd-4c7e-b85b-5b0e36ca73ea",
"_parent_code": "sample string 6",
"sales_organization_id": "2d415878-6009-4929-b246-0188625bbe4c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
},
"equipment_model_id": "29687a22-59d5-494a-a588-e21ea3bf2912",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4652c249-15a4-4b28-97e2-d73b293105ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bf69ce92-b821-4e93-b464-2c91bc535230",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dc196bdd-380c-4704-b750-e880f0296d6e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e6a618ed-dd57-447a-abfe-9e6dbaf188e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
},
"equipment_family_id": "93d90bd5-5212-4ebc-9c04-05e280936d00",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2705cb44-a41c-4e1b-b784-370cf2ccd1c3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "783a07a8-f8bd-4c7e-b85b-5b0e36ca73ea",
"_parent_code": "sample string 6",
"sales_organization_id": "2d415878-6009-4929-b246-0188625bbe4c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
},
"date_in_production_since": "2026-08-14T08:52:15.7555577+00:00",
"date_out_of_production_since": "2026-08-14T08:52:15.7555577+00:00",
"date_end_support": "2026-08-14T08:52:15.7555577+00:00",
"sales_organization_id": "9dddf387-2cec-4fe7-9e31-a26e9db0b008",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+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-08-14T08:52:15.7555577+00:00"
},
"project_status_id": "7294c38c-46da-416b-a685-3e363ea34bc8",
"project_status_code": "sample string 10",
"project_status": {
"id": "107fd8bd-f03d-496c-a2f6-1a305ee97ecc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "89692815-9adb-4d62-b029-e47625c9c5dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
},
"company_id": "bfd7c5f9-2d1b-454a-b890-2bcddd133e89",
"company_code": "sample string 12",
"db_address_id": "8ad53d04-1b3b-40d0-8adc-6639f9e2abed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9600d9f5-7d4f-4c94-b864-dace07694596",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b30627b8-066a-4ca8-a62e-2851edf5e6da",
"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-08-14T08:52:15.7555577+00:00",
"date_create": "2026-08-14T08:52:15.7555577+00:00",
"date_update": "2026-08-14T08:52:15.7555577+00:00",
"updated_by_user_id": "72919f0e-dcef-4a58-b640-7bd06979b29d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T08:52:15.7555577+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-08-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T08:52:15.7555577+00:00",
"date_last_job": "2026-08-14T08:52:15.7555577+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T08:52:15.7555577+00:00",
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00",
"is_mobile_installation": true
},
"job_type_id": "ac556783-4834-4541-bd56-b293fded6121",
"job_type_code": "sample string 7",
"job_type": {
"id": "6a820f18-7729-4e05-a74e-142b45f0cf50",
"name": "sample string 2",
"sales_organization_id": "e7ce682c-77af-468b-9c35-0cfd4866d007",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00",
"code": "sample string 7"
},
"job_priority_id": "9ac9b625-9215-48ec-891a-90c43ee17a25",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9d64c74e-135b-4c23-bece-9228a865d8f2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "60ca6e5f-e9ce-4892-a41a-e56644d77b8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
},
"job_status_id": "1cdf3397-5e12-43cf-8893-2209c885d651",
"job_status_code": "sample string 11",
"db_address_id": "bd3d17a9-ab9a-463e-9be3-b75b3af63f5c",
"contact_id": "594d8942-2ac0-4bb8-ba87-7a8909590681",
"requested_by_company_id": "64f0c88d-ac1b-4df5-95df-097df82b90a6",
"requested_by_contact_id": "b68dbf2d-c927-4524-bf36-1756f4d67163",
"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-08-14T08:52:15.7555577+00:00",
"due_date": "2026-08-14T08:52:15.7555577+00:00",
"date_create": "2026-08-14T08:52:15.7555577+00:00",
"date_update": "2026-08-14T08:52:15.7555577+00:00",
"date_closed": "2026-08-14T08:52:15.7555577+00:00",
"suggested_user_id": "5c332d97-deda-4a43-ad0e-be19f934cf1b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0483db95-af48-4394-8c76-3d806010aae5",
"db_language_id": "3214f354-f99d-436f-84f9-ae67c86324ca",
"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-08-14T08:52:15.7555577+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a44b6464-e7c8-4e7a-a0e5-14600274e2f9",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2f0d193a-5b5a-4a03-b93e-6c57d4483708",
"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": "69105800-5343-464c-983d-c23722ded359",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "50817d9d-0a1e-45ae-9326-8dfcd38f14c8"
},
"suggested_date_start": "2026-08-14T08:52:15.7555577+00:00",
"skill_id": "af6d1f7b-ca06-4baa-a953-d942af58d4bd",
"skill_code": "sample string 32",
"skill": {
"id": "614f2cd9-d7aa-48ea-b40b-71eb2b1e3b7b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4be7b415-b750-475b-90c0-9034e6922046",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9b306cbe-f59f-4157-91cc-62729701aed2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d541491b-bb6d-43ba-ab99-bf1ffe3365d8",
"db_currency_id": "54a18af5-3f4b-4b22-944b-b108b7f322c3",
"db_language_id": "bddc46ff-57ce-4e04-99de-2b0ed5fa7dc8",
"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-08-14T08:52:15.7555577+00:00"
},
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8097d81e-aaee-4f20-a9a8-ac254664aba1",
"date_reported_by_company": "2026-08-14T08:52:15.7555577+00:00",
"id2": 36,
"company_id": "ec6f9d5b-6830-416a-be9b-36f66695c187",
"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": "27265d75-8b5d-4fd2-9736-a7d9b7f0e3cf",
"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-08-14T08:52:15.7555577+00:00"
},
"work_instruction_details_id": "ccc94da0-75d9-42b8-a05b-0ab40b39da89",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "feec0104-818a-4751-b0af-f712ada66953",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c4d4bcba-fe35-4a88-9a29-8c2ae5d1494f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T08:52:15.7555577+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": "d6167c6b-9688-4736-9afb-0928d588c50e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T08:52:15.7555577+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.