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": "99c1a908-6c62-4f2e-a4bb-f97aec6b2604",
"jobs_id": "03647770-518d-4a56-8685-b04c51d3daec",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "69bf1980-d799-45a4-b6f4-78aceb0b77ed",
"_parent_id": "7dfe20ef-81e7-48ee-908e-47751cb9612c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8a33cf4a-3811-4139-b44e-d44a0e8bbbac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "51584d7f-0ea6-46e9-92d7-f927e13d7ae7",
"_parent_id": "fbf23883-4b98-41b8-bf67-59233192a3b7",
"root_parent_id": "8be871a6-bd6a-4182-a6c2-b1e57745a55b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d5921d96-eebb-4468-8aca-9de902728dcd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8fc4e120-1bf0-4725-b3de-0db44eb3c9bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2cb7e65-4e91-4ddb-b5b3-4d953232ddcd",
"_parent_code": "sample string 6",
"sales_organization_id": "fdfcbe7d-181c-48ba-be4a-df3757f83869",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"modified_dateutc": "2024-12-31T11:46:47.2129407+00:00"
},
"equipment_model_id": "a82f4141-27bd-4c6a-8699-ad445d3f5f54",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e16e1a9e-a8b2-4e5b-bad5-288a869a54f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "880cb10a-a960-410a-8f9f-33db943056d2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "15ee03e5-0332-4077-811b-d2b26a2c660c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c3ee9926-2567-4ac7-8e30-6de2003344c1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00"
},
"equipment_family_id": "22d2c502-cef9-4f65-971e-5f3c06444f5f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8fc4e120-1bf0-4725-b3de-0db44eb3c9bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2cb7e65-4e91-4ddb-b5b3-4d953232ddcd",
"_parent_code": "sample string 6",
"sales_organization_id": "fdfcbe7d-181c-48ba-be4a-df3757f83869",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"modified_dateutc": "2024-12-31T11:46:47.2129407+00:00"
},
"date_in_production_since": "2024-12-31T11:46:47.2285682+00:00",
"date_out_of_production_since": "2024-12-31T11:46:47.2285682+00:00",
"date_end_support": "2024-12-31T11:46:47.2285682+00:00",
"sales_organization_id": "811b5076-b156-40e7-bd21-1b03d2111fa2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+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-12-31T11:46:47.2285682+00:00"
},
"project_status_id": "7aa367da-ca73-4b22-b0ec-3f7467c564f4",
"project_status_code": "sample string 10",
"project_status": {
"id": "406dded2-5a64-4728-8343-2e2ecc754617",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f64fcad2-1985-460b-b662-677e23c02677",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00"
},
"company_id": "8c0b084d-8b34-477c-812a-661c372a982e",
"company_code": "sample string 12",
"db_address_id": "7c2ea8dd-aea9-4811-86b8-1643221be463",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7fd16c54-178c-407e-958d-7f62af47d153",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e9ca81ba-5f52-430c-bb55-491c1f41ac1e",
"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-12-31T11:46:47.2285682+00:00",
"date_create": "2024-12-31T11:46:47.2285682+00:00",
"date_update": "2024-12-31T11:46:47.2285682+00:00",
"updated_by_user_id": "58ad4127-8720-42a1-bd47-0508447695f5",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-31T11:46:47.2285682+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-12-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-31T11:46:47.2285682+00:00",
"date_last_job": "2024-12-31T11:46:47.2285682+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-31T11:46:47.2285682+00:00",
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00",
"is_mobile_installation": true
},
"job_type_id": "eb95ec61-a171-44fb-b94d-771e30d1fb19",
"job_type_code": "sample string 7",
"job_type": {
"id": "ecfb7bf1-b89b-4743-a2fe-4369b76ce02e",
"name": "sample string 2",
"sales_organization_id": "2d2c4547-cfd2-460c-99af-9f3b0a66bb3e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00",
"code": "sample string 7"
},
"job_priority_id": "e310bb18-d695-49f2-b730-6b0e2c297b13",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "786bebbe-51d2-40f8-a200-6b96a830f51e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "56449fb3-8de2-487f-ac0e-bb08e2c10050",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00"
},
"job_status_id": "af592cef-5de9-48a8-b6a1-5ad1622c99ee",
"job_status_code": "sample string 11",
"db_address_id": "eb7a3908-6a9e-44d4-924d-0368c9345843",
"contact_id": "346e0612-5e77-4f94-9b4e-cd9314442843",
"requested_by_company_id": "8ffd7c51-89a8-446d-a83f-71496e3ca044",
"requested_by_contact_id": "7e536927-b6c3-400a-ad88-bbd90aa140a0",
"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-12-31T11:46:47.2285682+00:00",
"due_date": "2024-12-31T11:46:47.2285682+00:00",
"date_create": "2024-12-31T11:46:47.2285682+00:00",
"date_update": "2024-12-31T11:46:47.2285682+00:00",
"date_closed": "2024-12-31T11:46:47.2285682+00:00",
"suggested_user_id": "b477aeaa-7240-49b6-94d9-ffad76d28c43",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ea3f0fd4-9a65-4822-8125-0c3ed9b9df7e",
"db_language_id": "1e677b53-c66a-499f-9894-f0a42c595dd6",
"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-12-31T11:46:47.2285682+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc6e03e8-7fd1-457f-86b6-75a9eeada40d",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "363fc2ec-de8a-4f58-8786-c6547bb14c79",
"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": "86464bec-0524-4c04-b0cf-724036f9992c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41324de0-5020-4ca8-80fb-1186f655d6ac"
},
"suggested_date_start": "2024-12-31T11:46:47.2285682+00:00",
"skill_id": "75e80dc4-6d77-44b2-9bb1-8039a744b04d",
"skill_code": "sample string 32",
"skill": {
"id": "01b49ef9-01b6-4f83-93ac-6e819c163b7d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5e0325b1-9e5c-43af-ad18-2917bec1f76f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a50b2b53-a558-48d2-9446-26c7aa93e552",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459f6ca6-c210-42eb-a7c9-6a530070081b",
"db_currency_id": "61b2cb98-ad8d-4e47-afc3-380472d188ba",
"db_language_id": "f5672736-ccf4-400b-8f55-721ab592210f",
"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-12-31T11:46:47.2129407+00:00"
},
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "631ddc70-050e-4b0e-b17a-395dff2eda04",
"date_reported_by_company": "2024-12-31T11:46:47.2285682+00:00",
"id2": 36,
"company_id": "8eec85d2-6552-407f-a62a-4cba4deddd53",
"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": "8db894cf-5895-4da1-a270-3d8a56ddae18",
"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-12-31T11:46:47.2285682+00:00"
},
"work_instruction_details_id": "a05c6bd2-01ea-440d-b680-aaa648690f06",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a6fef195-7780-47a9-9e2f-242c03138b8e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0c4dd9e8-7730-4bce-b239-030c59ca6cf3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-31T11:46:47.2285682+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": "f6c34d47-44f5-4e32-b882-8705be4db228",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-31T11:46:47.2285682+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.