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": "a27a8dde-3422-4a3f-ad02-3e7966b67d97",
"jobs_id": "bcdcbe4c-ab10-478f-8844-e5c14502c5ce",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "59e8f0c3-eb4c-46b6-98a3-23efeb31d261",
"_parent_id": "5cf45c92-2264-41d9-a690-b3993a592e4d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "989652d0-8bbf-4994-a6ce-40b7827e1260",
"project_reference_back_office": "sample string 5",
"project": {
"id": "743dfd97-a801-4d46-afc3-d8d745873867",
"_parent_id": "571e9b40-73c0-454a-bad5-90d5cb984679",
"root_parent_id": "8a0a7564-ce70-433f-9dec-85aa56cba103",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3f5442dc-2ca8-4ab2-9eac-58659da304c3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f81129f-b573-4dc6-b601-357989547123",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f7e32e3-44b8-4ce3-a7c1-a8c0d626d7b6",
"_parent_code": "sample string 6",
"sales_organization_id": "b7870a6e-d684-4894-877b-95d200a42eda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
},
"equipment_model_id": "97aeefae-c0e1-4808-a80e-ff1df91b4f9a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "322ae388-abe9-4e26-b6bf-8920ace7fd49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "733bce7d-9fab-432f-9f0c-994a6ba1c630",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1f6f3e02-e072-4cbd-b739-d5821e87bc70",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c87be98-566c-4c16-b39e-74fb0c24344c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
},
"equipment_family_id": "7d8f53f5-59dd-4d85-b137-038771b8712b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f81129f-b573-4dc6-b601-357989547123",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f7e32e3-44b8-4ce3-a7c1-a8c0d626d7b6",
"_parent_code": "sample string 6",
"sales_organization_id": "b7870a6e-d684-4894-877b-95d200a42eda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
},
"date_in_production_since": "2024-11-20T11:11:59.6847955+00:00",
"date_out_of_production_since": "2024-11-20T11:11:59.6847955+00:00",
"date_end_support": "2024-11-20T11:11:59.6847955+00:00",
"sales_organization_id": "e424e1a6-a195-4256-9f10-f670ffbf32f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+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": "2024-11-20T11:11:59.6847955+00:00"
},
"project_status_id": "e6901b4e-0eb5-4218-90c8-22f2a64b53c5",
"project_status_code": "sample string 10",
"project_status": {
"id": "4b7b8f9f-7503-4d83-85b2-109a97eeb8a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a7fb0360-2e65-4fa7-bdfb-72808c36dc3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
},
"company_id": "b223f457-21ac-45d5-a5c2-1dd8468d2f7f",
"company_code": "sample string 12",
"db_address_id": "96704757-4765-4103-b73f-d5580b63f671",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4d224d8a-09d0-4e5a-9d8d-777c235a968d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eddfc6ef-01f5-4501-ac88-4a6dd3d2565a",
"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": "2024-11-20T11:11:59.6847955+00:00",
"date_create": "2024-11-20T11:11:59.6847955+00:00",
"date_update": "2024-11-20T11:11:59.6847955+00:00",
"updated_by_user_id": "9d7e70a8-52a9-4984-bec6-43a23c636fb9",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-11-20T11:11:59.6847955+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": "2024-11-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-11-20T11:11:59.6847955+00:00",
"date_last_job": "2024-11-20T11:11:59.6847955+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-11-20T11:11:59.6847955+00:00",
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00",
"is_mobile_installation": true
},
"job_type_id": "d9f81319-974f-4d19-be9a-33cb05ac64e8",
"job_type_code": "sample string 7",
"job_type": {
"id": "4a05bd8e-57c5-42c5-919d-3d7106fea4e9",
"name": "sample string 2",
"sales_organization_id": "3e0dcd41-ab7f-42d9-a0cb-18283a422a5c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00",
"code": "sample string 7"
},
"job_priority_id": "78c96142-6f33-4890-b992-1b27103ce159",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "712247a9-15a7-42e6-a7a6-5cbccdecbb03",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4d3e17c1-f8dc-4f09-96c2-e7ccb5ef8240",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
},
"job_status_id": "e8531649-f48c-4d1e-9b7d-7459b4f92495",
"job_status_code": "sample string 11",
"db_address_id": "d717b170-321f-44e7-84da-99690b1ad4c1",
"contact_id": "a263b899-2656-4867-9b8c-144f56b5b9d6",
"requested_by_company_id": "7d743009-ebf3-4d7a-bdda-359adc82e36f",
"requested_by_contact_id": "e3b2583a-6911-4e6e-84f4-b00c5efea9dc",
"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": "2024-11-20T11:11:59.6847955+00:00",
"due_date": "2024-11-20T11:11:59.6847955+00:00",
"date_create": "2024-11-20T11:11:59.6847955+00:00",
"date_update": "2024-11-20T11:11:59.6847955+00:00",
"date_closed": "2024-11-20T11:11:59.6847955+00:00",
"suggested_user_id": "71e2ec10-612f-4031-bffc-57a6d39e70af",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1b777f79-7ac6-49ed-8bf4-748246cc41ee",
"db_language_id": "54efe82f-0509-42ad-8813-f45b17a2b40c",
"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": "2024-11-20T11:11:59.6847955+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "98025bdc-3f89-4325-8bc5-ce1682e8856a",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "64a3e456-e6b3-422d-9f00-c014fbbf43c2",
"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": "18441644-8d32-44e0-b506-6139b1370de9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ee8a17d1-6cef-4f68-8199-72d0bb120054"
},
"suggested_date_start": "2024-11-20T11:11:59.6847955+00:00",
"skill_id": "ec0018b8-2676-42e3-8aa2-9cf629dc99e0",
"skill_code": "sample string 32",
"skill": {
"id": "f7657829-04e3-4ac8-b837-2f5c331db6aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "26ea91a7-b772-4828-996d-c27d45809634",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b04ba38e-43ca-4087-8d66-8083f6c3b4fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61aa985b-7c2e-4728-a171-610ae4eb0c42",
"db_currency_id": "176ed4ca-bf0f-445e-b628-897ea5867618",
"db_language_id": "743078cd-6fc9-4a4d-b914-38ce733e7a96",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8bdfb920-f5da-491f-a77b-6a18ac2db6f4",
"date_reported_by_company": "2024-11-20T11:11:59.6847955+00:00",
"id2": 36,
"company_id": "47d0d44d-93df-4604-9d7b-e30f935c960c",
"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": "4d53896e-4d2c-4164-aad0-1c9fcb5cf60e",
"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": "2024-11-20T11:11:59.6847955+00:00"
},
"work_instruction_details_id": "738687c6-12de-4f10-87c9-7e3b527cd87c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1893d2d6-7058-4bdc-abaa-ab48f664bcef",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c47d437f-39c5-4ec6-a2e9-8bc984528dea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-11-20T11:11:59.6847955+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": "664bde92-5946-488c-9f30-e3dedb7e2f5f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-11-20T11:11:59.6847955+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.