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": "48c36625-5f87-4c9c-868a-3fade75c3af4",
"jobs_id": "b0d08b90-4af4-408c-a513-b1e644d4d88b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4ad3f0be-0b5e-4e3b-b899-bb3620e1be58",
"_parent_id": "5d44c4f0-461e-46cf-8808-aab39832dfb1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fadb9d89-8280-40d0-b5fd-87b102edded2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a006f273-bb40-4d16-aa17-790bbd6f9c39",
"_parent_id": "0055a87b-2061-438c-aa19-27bdafe97939",
"root_parent_id": "d7a724c8-9c8c-4573-aba4-ef81b569bc44",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "04a20f66-d8b8-474e-9d85-9e697227cb9d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ed58b9c9-eb5b-4399-9623-79e1da3f9f00",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7f286cbb-afce-4398-8bda-9da0e2490ce9",
"_parent_code": "sample string 6",
"sales_organization_id": "9aebcc53-3686-48dd-9ca7-0ee6bcb8fbf6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
},
"equipment_model_id": "e74204ee-269a-42f7-bff6-3ce9f03f5227",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2eefed34-87d8-4fa3-966b-0d1a4260b41e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9827c7a3-468f-450e-ae75-ef7b3a195957",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "307f1dd1-5051-4104-acb7-6539c2c525c9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2d219628-a74b-4b65-adf4-547234005ffe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
},
"equipment_family_id": "9be652f9-3139-47b5-9335-d6098e4a2c12",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ed58b9c9-eb5b-4399-9623-79e1da3f9f00",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7f286cbb-afce-4398-8bda-9da0e2490ce9",
"_parent_code": "sample string 6",
"sales_organization_id": "9aebcc53-3686-48dd-9ca7-0ee6bcb8fbf6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
},
"date_in_production_since": "2023-03-21T15:28:07.0652469+00:00",
"date_out_of_production_since": "2023-03-21T15:28:07.0652469+00:00",
"date_end_support": "2023-03-21T15:28:07.0652469+00:00",
"sales_organization_id": "dd358f89-68c6-4932-aea5-b8e343753d18",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+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": "2023-03-21T15:28:07.0652469+00:00"
},
"project_status_id": "189b1c36-17da-478e-be44-39c2381ee3da",
"project_status_code": "sample string 10",
"project_status": {
"id": "3ec5a02f-29e4-4072-a706-6beb3e62eff7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "897d26dd-7145-4633-a151-02d6e14b7b06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
},
"company_id": "8f9c0716-3c9b-400a-9302-57604c628af2",
"company_code": "sample string 12",
"db_address_id": "a9521b8c-bae0-40ad-bf0b-987bae56f8a7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "13c73c7a-9c3f-4797-848c-0065618fbaa8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4373091e-883c-4d40-b4dd-11e3a2367f83",
"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": "2023-03-21T15:28:07.0652469+00:00",
"date_create": "2023-03-21T15:28:07.0652469+00:00",
"date_update": "2023-03-21T15:28:07.0652469+00:00",
"updated_by_user_id": "54e7e261-1c79-487c-af90-d04d8a3edcf0",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-03-21T15:28:07.0652469+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": "2023-03-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-03-21T15:28:07.0652469+00:00",
"date_last_job": "2023-03-21T15:28:07.0652469+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-03-21T15:28:07.0652469+00:00",
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00",
"is_mobile_installation": true
},
"job_type_id": "6aed79ca-56f0-4e4e-a5e3-9f40e0b8375d",
"job_type_code": "sample string 7",
"job_type": {
"id": "e929a104-dccb-4d21-bc0c-1e4728c63233",
"name": "sample string 2",
"sales_organization_id": "6e055db1-1851-47d0-a3a4-ade1b0bf8b87",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00",
"code": "sample string 7"
},
"job_priority_id": "8eb8a789-4cb1-467c-a0f5-fa67a859015c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fffc02ea-6c45-4d15-97a5-68b5c743ecd2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5f024bed-8ca2-469e-941a-f9eb1114ea40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
},
"job_status_id": "46a84d4e-5b3f-4165-9b95-15eda55f048c",
"job_status_code": "sample string 11",
"db_address_id": "c0a8870d-ff9a-4f7e-8fed-54732b3d912f",
"contact_id": "8c5e4090-e565-468e-938d-2ca84a2ec068",
"requested_by_company_id": "1eed3837-1329-426f-9126-6fd78a8ead8f",
"requested_by_contact_id": "010c6a8e-8d21-4e94-8200-9c619066e4ad",
"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": "2023-03-21T15:28:07.0652469+00:00",
"due_date": "2023-03-21T15:28:07.0652469+00:00",
"date_create": "2023-03-21T15:28:07.0652469+00:00",
"date_update": "2023-03-21T15:28:07.0652469+00:00",
"date_closed": "2023-03-21T15:28:07.0652469+00:00",
"suggested_user_id": "fc79b6cc-b986-4f97-82c6-d6f1508399d2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "efa9a5b3-b8ee-424a-87a3-eb31497fddc4",
"db_language_id": "60bdcde4-e9d3-421b-8c32-950a5ddf50db",
"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": "2023-03-21T15:28:07.0652469+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "536cada2-48bd-4aee-9ba8-70761ce9f14c",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "499c1696-1a77-45bc-9a5f-5496b8e35613",
"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": "4c1b188d-5329-410f-ad3e-80cc96836533",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4ad5f8f5-456a-4b83-93d9-018490c3dfad"
},
"suggested_date_start": "2023-03-21T15:28:07.0652469+00:00",
"skill_id": "53e2e0e5-a828-467d-812f-6dde7dd3e152",
"skill_code": "sample string 32",
"skill": {
"id": "29f2530c-2a5c-40a9-8d12-3243db7cf305",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "af97ca1c-dc67-429b-871d-86e4f24283e1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e842b87a-4430-4cd3-94e1-c235d95be6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cdd328c-e210-468f-8581-1f40c9abb231",
"db_currency_id": "9c999cce-34fa-41b4-b5f4-31707f0612b0",
"db_language_id": "68018c9d-ee1c-4041-b3c1-1e471c5d6790",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6ba2e1c4-abff-4649-ad33-4a3acc59a26a",
"date_reported_by_company": "2023-03-21T15:28:07.0652469+00:00",
"id2": 36,
"company_id": "2b02da4b-7492-4aff-a9ee-12408e7fe352",
"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": "bdcd4422-b3be-49d9-85b8-7180e05b0a23",
"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": "2023-03-21T15:28:07.0652469+00:00"
},
"work_instruction_details_id": "49c15c52-9a66-4f9f-be6a-a48311794cd4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8111a6b7-5007-4ba4-9251-37b2f6500c44",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "491eb7f7-b62b-4a51-8a4d-b2fed73daca6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-03-21T15:28:07.0652469+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": "d53182ed-6f86-4c76-9c65-05cd7df4728c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-03-21T15:28:07.0652469+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.