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": "e922220c-9b33-4181-8869-dbc96c226076",
"jobs_id": "ead0eb32-c638-4795-b9e3-71008d9f73af",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db19722f-5fd8-4f49-ba5e-880d983139f6",
"_parent_id": "a96a09f6-23c8-47a9-8b11-da7edfabfdda",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "43aadfc2-6b16-4ea5-b9c1-a7c4356e2527",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bb85f62f-80af-456d-8ab4-37f6fe11363d",
"_parent_id": "ffc31cf3-14ff-4268-90bb-1f87c6eae883",
"root_parent_id": "ea4f0fd2-d3f4-4adf-9a8e-17d3b8841b1b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "17e37a9a-5f1d-450c-bd92-6abc2be1faed",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6d10d3c4-58ae-4629-b64e-d2469325628c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fed1786b-7624-4031-96f9-0c09ef6c5d8b",
"_parent_code": "sample string 6",
"sales_organization_id": "e2098c25-92a3-44d9-aa27-d63e0aecf432",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
},
"equipment_model_id": "1db9c8c8-b44e-42cd-847b-8e2788b5ad67",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5a4469ae-b516-49e2-ada0-d8a9520db7ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9e788b74-55f8-4ebe-8664-a359e868e773",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "beccb0a1-7b33-404e-8e28-e6cbb76d29fb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "77f67935-268e-4c62-b1e9-ca01bd77eca3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
},
"equipment_family_id": "1112ccca-7cd5-49df-bb70-11d684894be2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6d10d3c4-58ae-4629-b64e-d2469325628c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fed1786b-7624-4031-96f9-0c09ef6c5d8b",
"_parent_code": "sample string 6",
"sales_organization_id": "e2098c25-92a3-44d9-aa27-d63e0aecf432",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
},
"date_in_production_since": "2025-05-31T23:51:04.0249976+00:00",
"date_out_of_production_since": "2025-05-31T23:51:04.0249976+00:00",
"date_end_support": "2025-05-31T23:51:04.0249976+00:00",
"sales_organization_id": "863a1275-ef82-44ad-8d94-964b3891d111",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+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": "2025-05-31T23:51:04.0249976+00:00"
},
"project_status_id": "8e51fa19-0edc-451b-88e1-2100a70a49dd",
"project_status_code": "sample string 10",
"project_status": {
"id": "37c1f34b-b263-4377-adeb-2e6a97138b48",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "64dc17fe-8cda-47d9-a9fc-79dce1bae520",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
},
"company_id": "fc53bb3a-0101-4867-b032-5ef60596ea46",
"company_code": "sample string 12",
"db_address_id": "504df506-cd84-4eef-8fd4-e158982ad676",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8f65f3b7-b388-43c8-afea-b94a37544348",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5f36ef5a-1fae-4544-a161-539d39f3079b",
"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": "2025-05-31T23:51:04.0249976+00:00",
"date_create": "2025-05-31T23:51:04.0249976+00:00",
"date_update": "2025-05-31T23:51:04.0249976+00:00",
"updated_by_user_id": "313ab026-82da-43ea-a26d-bb3d589d0fcb",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-31T23:51:04.0249976+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": "2025-05-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-31T23:51:04.0249976+00:00",
"date_last_job": "2025-05-31T23:51:04.0249976+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-31T23:51:04.0249976+00:00",
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00",
"is_mobile_installation": true
},
"job_type_id": "41c48a0d-de30-4a80-a931-c66d6ad0a89e",
"job_type_code": "sample string 7",
"job_type": {
"id": "4ba27f7f-6d7b-4fb6-870e-5028d8ba693a",
"name": "sample string 2",
"sales_organization_id": "3afa96d9-d3eb-4ad8-8a4f-6f56e94089e8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00",
"code": "sample string 7"
},
"job_priority_id": "36735c89-11fd-474d-937f-d79f10b3c618",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "74d0ac98-60f4-443d-9bcf-af302377561f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "265ac9cb-7db1-45e9-8ebb-4bfdd1c6b8fc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
},
"job_status_id": "2298eeea-9633-4dea-a02d-b573e40b4710",
"job_status_code": "sample string 11",
"db_address_id": "125564e3-7d55-428f-a894-d3872a5767c2",
"contact_id": "0caca12a-f8d0-45b4-b42a-8d4a70e0f087",
"requested_by_company_id": "072ab772-a1cb-4418-b5a4-888da5b3cd3e",
"requested_by_contact_id": "8330c3fb-a86c-470d-a8df-ab27bace59f0",
"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": "2025-05-31T23:51:04.0249976+00:00",
"due_date": "2025-05-31T23:51:04.0249976+00:00",
"date_create": "2025-05-31T23:51:04.0249976+00:00",
"date_update": "2025-05-31T23:51:04.0249976+00:00",
"date_closed": "2025-05-31T23:51:04.0249976+00:00",
"suggested_user_id": "8e6c98a1-6712-4c07-96d1-a6fbd5199b3c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "17bc566d-c473-4da7-8445-5e2beb343263",
"db_language_id": "4fe0daa1-8063-4ee2-b88a-d80073c2eac0",
"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": "2025-05-31T23:51:04.0249976+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ec53305f-c27c-4170-88f9-ee3b53f916a8",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6c30e121-44c9-4872-ad70-77493be68d7f",
"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": "194701be-779d-4dd7-807e-78ad42709f0f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2f48703c-4243-4085-8d9b-410ed34243fa"
},
"suggested_date_start": "2025-05-31T23:51:04.0249976+00:00",
"skill_id": "a3f766dc-f549-4e8f-a3c6-a64e1bf822cd",
"skill_code": "sample string 32",
"skill": {
"id": "2b75fd67-5569-4bd7-959f-546c2fc8f75d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e48b95df-5702-42ad-af30-4c6ecd835dcf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1df0db1-12a7-4815-914f-4791e99a0547",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16db3ee2-1c85-4de5-8b3d-e3d0f3c2e3b5",
"db_currency_id": "8a2e116a-485d-400e-8a69-32a7806ec61e",
"db_language_id": "d19e8c90-7796-4aff-a2ec-ce011f73fef4",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "70cae9da-c968-4f3c-aa40-fbd158e8e3ef",
"date_reported_by_company": "2025-05-31T23:51:04.0249976+00:00",
"id2": 36,
"company_id": "d8669d41-d76f-4629-99df-6709daba38f8",
"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": "a698a256-4921-4c2a-b4e0-28ce61feec99",
"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": "2025-05-31T23:51:04.0249976+00:00"
},
"work_instruction_details_id": "337b147b-d7fe-4994-8419-5dbbf0cca536",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1eaa1e01-7eae-4261-a680-9123e0476f4f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5890d769-be96-4ea4-a594-e4d41e17406f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-31T23:51:04.0249976+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": "c4e2e75a-0e4e-44e4-a54d-e2a99aacda48",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-31T23:51:04.0249976+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.