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": "ff0f6997-03a2-490c-9bd8-336cdc019cf3",
"jobs_id": "6b393d4c-5d49-4014-b423-8c0966424464",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "51b120e7-e1ad-43ba-837b-d6d46df54871",
"_parent_id": "e353635e-9161-4154-80a2-ea905c1a8c83",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "96a0d22c-97fb-43d8-a19f-284eca73c9ed",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5944a06c-9591-4a5b-81b3-1b9386bf5a72",
"_parent_id": "ac14ba17-cd5b-4cd2-989f-652547d0aa0c",
"root_parent_id": "3c6f7a75-0eb8-4556-b0b0-082a6d175e9e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0749f7a0-72f4-435b-a044-d2a027ef01a4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "29c854cf-a17f-4d00-afcb-f32809024814",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "628b13e3-3d30-4c20-b355-7af20c572e5e",
"_parent_code": "sample string 6",
"sales_organization_id": "abd542b8-8664-47db-8bb0-b61ef8a02bec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
},
"equipment_model_id": "62f626a1-dea7-4e05-9787-ef5ae0a0dec7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9a486e7c-1bae-4522-aacf-b3940a4d5218",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "185cdf2e-b323-437e-b383-0f0575be0a2d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "19f48eff-045b-4fd9-af1b-1069f157714d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "812fb002-4300-43b7-a256-d6bbaf06935b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
},
"equipment_family_id": "7ded8960-adda-4eb8-820e-f665d6f8c0de",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "29c854cf-a17f-4d00-afcb-f32809024814",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "628b13e3-3d30-4c20-b355-7af20c572e5e",
"_parent_code": "sample string 6",
"sales_organization_id": "abd542b8-8664-47db-8bb0-b61ef8a02bec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
},
"date_in_production_since": "2024-11-21T09:39:36.4957441+00:00",
"date_out_of_production_since": "2024-11-21T09:39:36.4957441+00:00",
"date_end_support": "2024-11-21T09:39:36.4957441+00:00",
"sales_organization_id": "367f8fe7-c852-4c03-8589-a649af34ca9c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+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-21T09:39:36.4957441+00:00"
},
"project_status_id": "6f542bb3-a96c-480f-a613-c884e18e9204",
"project_status_code": "sample string 10",
"project_status": {
"id": "b4db5266-afaf-446f-8f0f-1bdc6fa37708",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4d2c1157-f6e3-4483-ad6b-8b38ad503e6d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
},
"company_id": "8576b1aa-6506-4061-85a8-973e6ed3f943",
"company_code": "sample string 12",
"db_address_id": "18149150-2c6c-4a94-adbd-2a978b237caf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "231e3552-568e-4b34-9e0d-347597610da5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "76da5dc9-5f7b-4351-8801-c86c394ffbea",
"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-21T09:39:36.4957441+00:00",
"date_create": "2024-11-21T09:39:36.4957441+00:00",
"date_update": "2024-11-21T09:39:36.4957441+00:00",
"updated_by_user_id": "f3505292-bda7-4c7d-8878-914d545f789b",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-11-21T09:39:36.4957441+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-11-21T09:39:36.4957441+00:00",
"date_last_job": "2024-11-21T09:39:36.4957441+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-11-21T09:39:36.4957441+00:00",
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00",
"is_mobile_installation": true
},
"job_type_id": "e6d303b0-c04e-4652-a335-079ff65aa961",
"job_type_code": "sample string 7",
"job_type": {
"id": "a13f2b5a-0471-4d17-ab5b-803630e8a025",
"name": "sample string 2",
"sales_organization_id": "deaf3369-08fc-4fff-849c-75b80a1311ee",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00",
"code": "sample string 7"
},
"job_priority_id": "d70d99ae-eb9f-4473-b0e2-7771f5e77434",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "250bf195-6fd6-4730-8374-8f6eb66de9b8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "66b70855-1fb1-4a99-990a-28f68dd8c287",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
},
"job_status_id": "3ef86b0c-880a-4faf-87a4-009d1d994590",
"job_status_code": "sample string 11",
"db_address_id": "35215a6f-8372-4a57-beef-a2fcb6e47fff",
"contact_id": "75a07aa9-48af-49f6-aef8-bcbbcb5d4991",
"requested_by_company_id": "3216a67b-c57f-4f1b-84d5-dbac43c809e2",
"requested_by_contact_id": "16d31e3c-a752-4f17-aac4-34ace8d58788",
"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-21T09:39:36.4957441+00:00",
"due_date": "2024-11-21T09:39:36.4957441+00:00",
"date_create": "2024-11-21T09:39:36.4957441+00:00",
"date_update": "2024-11-21T09:39:36.4957441+00:00",
"date_closed": "2024-11-21T09:39:36.4957441+00:00",
"suggested_user_id": "409ec529-a335-4593-a4e7-a9091c20118a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "611fb525-3675-4fd3-9628-609a33e84ae9",
"db_language_id": "aa974f91-f568-47a0-a26b-5e1a6d49ed85",
"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-21T09:39:36.4957441+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a3fe5f86-5b0d-4b43-a887-3ae6fdd46d22",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8d0a4954-035b-41fb-8ee6-e1f0e7f68be5",
"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": "85737a45-5436-4bd0-a22c-35a5a080598e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "094e402c-ae1e-402f-bbcc-fb56003fcad7"
},
"suggested_date_start": "2024-11-21T09:39:36.4957441+00:00",
"skill_id": "e7838db8-77f8-49d3-97a0-0e59b9574171",
"skill_code": "sample string 32",
"skill": {
"id": "bd906a67-0a46-4595-9da9-5293905582f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b4c56d01-e9c5-4e08-a49f-6d0426b59bf8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3616000e-8838-4292-8eb7-76c7c265cf3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e65b18bf-0ba1-4b88-9451-d18284cbb1ca",
"db_currency_id": "18ec295f-3984-4a8a-8a93-bd7113ca591f",
"db_language_id": "b550a147-f87d-4353-8ed8-948d5206fe4e",
"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-21T09:39:36.4957441+00:00"
},
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4761df34-3b58-47e3-b9d3-7c01cb170d0c",
"date_reported_by_company": "2024-11-21T09:39:36.4957441+00:00",
"id2": 36,
"company_id": "155af732-9ab2-478e-91d1-697429910e94",
"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": "04337e8a-973e-4090-8f41-b615fefaf856",
"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-21T09:39:36.4957441+00:00"
},
"work_instruction_details_id": "0bf9ca77-1050-4f67-8a42-fe415e541b87",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4440d280-eba0-4e99-990c-e5da1885d14d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "05ce27b2-602c-4819-9762-2bf63b95020c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-11-21T09:39:36.4957441+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": "78476cfd-115f-46d1-ac6d-1a6a47b86f35",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-11-21T09:39:36.4957441+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.