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": "f2c60f40-e48f-4884-8f8c-888d7ea3d267",
"jobs_id": "9188cb8f-22a4-47a7-bcab-cb61ad5bce0b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b6d057f1-35d9-4766-b120-824177c534af",
"_parent_id": "6f800417-4f8c-4668-b9c1-d2a519d2a280",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5caf1d2d-128a-4d9b-a463-9c1facc2512f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f53ee6cb-48aa-4145-af35-8305d3ba8c47",
"_parent_id": "c8ef5ee9-1275-4c75-baaf-5db4a31d29f3",
"root_parent_id": "e8584e6a-042b-4da8-bcd8-a8fa95404b77",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "897cbe24-b73c-472b-a169-3d9715e41abf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7c337619-94de-4e94-8ee1-b7861101c3f7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9087b0be-f973-400a-96de-2c5c94f691e8",
"_parent_code": "sample string 6",
"sales_organization_id": "e37190b2-6c93-43ca-8def-6d3e79629ae0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
},
"equipment_model_id": "025ec0f3-7621-43f1-8ba2-27a7a9db8b45",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8ac03877-9e50-47b1-970b-5dc8870a64e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "67999463-2fe7-48cc-aede-a8f1a15eef99",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "974841c4-800b-42b5-9b0c-aca99ca47a8f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5a266bd3-a09f-4a13-969e-cb3254d95934",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
},
"equipment_family_id": "4187f0af-61c8-4686-9f15-78470d72adf5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7c337619-94de-4e94-8ee1-b7861101c3f7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9087b0be-f973-400a-96de-2c5c94f691e8",
"_parent_code": "sample string 6",
"sales_organization_id": "e37190b2-6c93-43ca-8def-6d3e79629ae0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
},
"date_in_production_since": "2025-02-22T17:28:04.1255592+00:00",
"date_out_of_production_since": "2025-02-22T17:28:04.1255592+00:00",
"date_end_support": "2025-02-22T17:28:04.1255592+00:00",
"sales_organization_id": "c41e599e-a2c4-44de-96a7-de2c6fcc26c9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+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-02-22T17:28:04.1255592+00:00"
},
"project_status_id": "9b9f0a65-e3bf-4189-8193-1b7d956d2217",
"project_status_code": "sample string 10",
"project_status": {
"id": "b50fe9bd-c6f2-428f-8101-e4edbde84b96",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a83eb117-255b-46d5-9711-459cbc9af725",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
},
"company_id": "17dcc065-c94b-43fb-8621-2fb39b3b25e6",
"company_code": "sample string 12",
"db_address_id": "f9b373cb-40ba-45b9-a3fc-ede9ae0ed4a0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1de8da69-b1a3-4432-982e-2ffd6a82b62c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4aeebf5b-6090-4cad-912f-ea0bb707209a",
"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-02-22T17:28:04.1255592+00:00",
"date_create": "2025-02-22T17:28:04.1255592+00:00",
"date_update": "2025-02-22T17:28:04.1255592+00:00",
"updated_by_user_id": "6a094b44-c3b3-4f0d-9862-56168196ec1d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-02-22T17:28:04.1255592+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-02-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-02-22T17:28:04.1255592+00:00",
"date_last_job": "2025-02-22T17:28:04.1255592+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-02-22T17:28:04.1255592+00:00",
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00",
"is_mobile_installation": true
},
"job_type_id": "12ee5194-b65c-461b-afb0-1f52a64a0e85",
"job_type_code": "sample string 7",
"job_type": {
"id": "0e8c3d05-032f-41d0-9aa5-f0005e1d864d",
"name": "sample string 2",
"sales_organization_id": "5f153a73-f318-442e-a1dd-e7e2ceb06875",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00",
"code": "sample string 7"
},
"job_priority_id": "658dbedd-399d-47c9-9d19-3935f16e38d5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a005e0a8-a8aa-42a9-9952-df44e267a997",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cd4c8244-ec70-4904-849e-365cb0371e8f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
},
"job_status_id": "2894266e-0315-4e8f-be09-d3342a0fadb6",
"job_status_code": "sample string 11",
"db_address_id": "3c8c3a3b-806c-45e3-b5af-b5d3a4399d13",
"contact_id": "b9db3f66-edfd-4f4d-a2b5-32b3433b18d1",
"requested_by_company_id": "11230038-fe54-4f48-a2fb-0a64c1938da4",
"requested_by_contact_id": "31c99c03-b3ad-423a-9526-5b4a0aa27774",
"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-02-22T17:28:04.1255592+00:00",
"due_date": "2025-02-22T17:28:04.1255592+00:00",
"date_create": "2025-02-22T17:28:04.1255592+00:00",
"date_update": "2025-02-22T17:28:04.1255592+00:00",
"date_closed": "2025-02-22T17:28:04.1255592+00:00",
"suggested_user_id": "c08461e7-a069-4381-ad97-7ec235911e33",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b5847172-5eec-4a27-9744-02acd1573735",
"db_language_id": "03094b2c-ccac-4ff3-9ccc-a11baf08825f",
"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-02-22T17:28:04.1255592+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9965ea6d-19f4-49ad-b5ca-82012169e709",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4e28f441-0645-496a-8ba4-7808121a183d",
"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": "1e07fb88-c1b0-4464-add3-5db6533314ed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c4f308ef-56fe-4ef4-bf51-fc0dc7bc36b1"
},
"suggested_date_start": "2025-02-22T17:28:04.1255592+00:00",
"skill_id": "c2b4c766-1756-458a-8aab-d721c0cd03a6",
"skill_code": "sample string 32",
"skill": {
"id": "bdc21231-005d-404b-8d0f-656755a44478",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "87df465d-6bba-48d5-9945-de89c1752633",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e7cf89d-6cf5-46f0-88dd-11db0c04e275",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4886483-62ac-4fca-ad87-9ca856d29708",
"db_currency_id": "22fcbdd3-4f4f-4979-b046-1df0d27fd369",
"db_language_id": "bd696d1c-3996-4ba0-9af1-6c2f0d841c5e",
"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-02-22T17:28:04.1255592+00:00"
},
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aca500eb-085a-417d-94b3-a16bb9f1f330",
"date_reported_by_company": "2025-02-22T17:28:04.1255592+00:00",
"id2": 36,
"company_id": "2a7af092-dfa6-41a1-a207-df01fc26ac5a",
"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": "b644ec5c-b039-423c-a4ef-08a23bd7e6d2",
"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-02-22T17:28:04.1255592+00:00"
},
"work_instruction_details_id": "4493456e-974e-4293-a27d-68f8d15fa79c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "587770dc-80f9-4d69-bfc6-4fa229393d90",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "420b169d-39c6-4b62-9d5d-b0eaf41fc4e0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-02-22T17:28:04.1255592+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": "af3b1bc1-c610-4d12-8312-f44ef388d2cb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-02-22T17:28:04.1255592+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.