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": "606c28ca-9f7c-4197-a9ad-a06b66139ec1",
"jobs_id": "24f1e850-8c3f-4785-a5c3-ec27bc7437f5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "131b39a7-7042-4a91-8217-bc433f2ce9c2",
"_parent_id": "9c55c4a1-3028-4838-a966-7c32d85ee523",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "368c2f77-f95e-4f4b-9795-cdb0742d942f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "18e75168-e9f0-4c27-9f4d-8ce391b25164",
"_parent_id": "16c4369e-5a45-409e-b240-fc0a004437ca",
"root_parent_id": "7533e2c5-7fd5-4866-8924-02781d4f8a61",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9cd9a9e9-a017-43a6-a49f-703cc1e85b1a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fe4c7ae2-6728-432a-bf20-c249ec26080e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c0f54b5-bfbf-48cf-98f4-52e95639931b",
"_parent_code": "sample string 6",
"sales_organization_id": "ba111931-7b5b-4369-8825-1a0698764a69",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00"
},
"equipment_model_id": "919f50d8-fe97-4f4f-9f51-0b2b24f4c267",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e7efceb9-2b40-48af-81c6-c225ce768a00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c21f331b-7517-425d-96dd-749886dbe4d6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "68190e1b-2d36-4340-bda8-aa901cccea5f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ab92676-eca2-4a47-aade-ed92891ca95f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00"
},
"equipment_family_id": "70b2ccf8-0302-49ce-897c-a892599319c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fe4c7ae2-6728-432a-bf20-c249ec26080e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c0f54b5-bfbf-48cf-98f4-52e95639931b",
"_parent_code": "sample string 6",
"sales_organization_id": "ba111931-7b5b-4369-8825-1a0698764a69",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00"
},
"date_in_production_since": "2025-01-22T01:20:37.1840465+00:00",
"date_out_of_production_since": "2025-01-22T01:20:37.1840465+00:00",
"date_end_support": "2025-01-22T01:20:37.1840465+00:00",
"sales_organization_id": "e03df8b0-874a-48c9-884e-cdbdaa901d9f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+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-01-22T01:20:37.1840465+00:00"
},
"project_status_id": "49331330-8331-42d8-b57b-17bd82a7cd43",
"project_status_code": "sample string 10",
"project_status": {
"id": "a4a0b9f2-9cc4-4155-b156-e043bc43c6ae",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "669967d9-990e-4bee-b4d9-feb2b38e2700",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00"
},
"company_id": "e248ef31-4250-432f-9751-a247d54619f5",
"company_code": "sample string 12",
"db_address_id": "9e9ce970-49a0-478a-b270-aa27083c40cc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d4be5a8c-0b5b-4da2-9cf7-e88ace05ed2f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d213053d-81ce-4a39-bd32-7b64402c22f2",
"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-01-22T01:20:37.1840465+00:00",
"date_create": "2025-01-22T01:20:37.1840465+00:00",
"date_update": "2025-01-22T01:20:37.1840465+00:00",
"updated_by_user_id": "6b71caa8-1176-43be-9be9-cae0d2ebd1d0",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-01-22T01:20:37.1840465+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-01-22T01:20:37.1840465+00:00",
"date_last_job": "2025-01-22T01:20:37.1840465+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-01-22T01:20:37.1840465+00:00",
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00",
"is_mobile_installation": true
},
"job_type_id": "c4e54383-c3bc-438a-bf4b-cf947a5a14e2",
"job_type_code": "sample string 7",
"job_type": {
"id": "73e8c76e-5cb1-4119-b47c-a25288ded1cf",
"name": "sample string 2",
"sales_organization_id": "dc41edc9-074d-41a8-9f52-7925be7dac07",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00",
"code": "sample string 7"
},
"job_priority_id": "14c0386c-4d5e-4136-a932-2c114914a58c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "435b60cb-de9a-44da-877a-53eed59aadee",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "94672800-cd53-4fe7-8d82-0eec71909745",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:20:37.1840465+00:00"
},
"job_status_id": "0c1fe8f1-43e7-4642-8588-27aa2c64853f",
"job_status_code": "sample string 11",
"db_address_id": "bafa1ea0-90bc-4656-9e20-85607cf6f86a",
"contact_id": "0426a7df-7ad4-47e2-834e-d978712acfde",
"requested_by_company_id": "2822f39d-171f-4339-ab57-052258ab96d8",
"requested_by_contact_id": "fb1df195-fe07-4337-b6ca-e8d0b5784620",
"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-01-22T01:20:37.1840465+00:00",
"due_date": "2025-01-22T01:20:37.1840465+00:00",
"date_create": "2025-01-22T01:20:37.1840465+00:00",
"date_update": "2025-01-22T01:20:37.1840465+00:00",
"date_closed": "2025-01-22T01:20:37.1840465+00:00",
"suggested_user_id": "6ef13f05-ab03-4cad-8a1a-0f408796c722",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cf6d6e59-bef7-4964-a3c5-e5c679d96dc0",
"db_language_id": "bf4574c2-4c73-42e4-81eb-75237841f42a",
"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-01-22T01:20:37.1996735+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f88dcc94-29a3-431d-941e-14b39f0eaf41",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "385c7f2d-40a2-48d2-be3c-7b367ee0adc6",
"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": "16994a34-b4c3-4a76-a265-3a6135654967",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-01-22T01:20:37.1996735+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce3147b9-9441-4b26-af98-4e8ba5671f56"
},
"suggested_date_start": "2025-01-22T01:20:37.1996735+00:00",
"skill_id": "66307135-8086-4cb9-a681-3ca8c9ec2682",
"skill_code": "sample string 32",
"skill": {
"id": "513dee24-7fa3-468d-8c9f-9a5ef19209aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f497ec44-a8fe-480a-9b52-c7b46624ddae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bc7e9843-e3ca-4abc-b732-923616449ed1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e2971e-1c70-4657-bffb-f47e68743439",
"db_currency_id": "ee332d25-3bd5-431b-8def-e53a3bdb28d4",
"db_language_id": "22421a0f-5746-4a03-8f19-739fa4802bac",
"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-01-22T01:20:37.1840465+00:00"
},
"modified_dateutc": "2025-01-22T01:20:37.1996735+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a69d41ee-a18e-431c-8371-9a2b44612655",
"date_reported_by_company": "2025-01-22T01:20:37.1996735+00:00",
"id2": 36,
"company_id": "b44cbb47-86c1-4347-b776-631506392043",
"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": "f448aa29-7eab-43da-8164-600929c67cc3",
"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-01-22T01:20:37.1996735+00:00"
},
"work_instruction_details_id": "2c59bf41-1f71-4f23-a090-29d0ef6f957e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "726bf08d-9b07-40ca-a11d-9f280f3528c1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8fa0da9e-bb4f-4ec5-9274-85a4e79e9ce8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-01-22T01:20:37.1996735+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": "0eb409df-bb68-4ba4-9bcf-b0bd06dbb5d0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-01-22T01:20:37.1996735+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.