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": "6b3e892a-61e4-4400-8469-af0ecc35110f",
"jobs_id": "0857284c-7d77-49f0-973b-55cc197ad122",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "70839395-bda9-457a-8848-49bac03589be",
"_parent_id": "b151177d-be90-4e94-8d72-51cb9aa098d1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8981665e-23ab-4d6f-8a35-f92b493f0706",
"project_reference_back_office": "sample string 5",
"project": {
"id": "45844008-c7da-489d-8c30-da4d59a8b3a5",
"_parent_id": "4c032e6a-df97-49d4-bc48-b0941092a746",
"root_parent_id": "37f37b9f-9954-476d-b875-f448088a96e7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8eeb0dbf-7912-4ed0-ada3-8b276629e46e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2f0bfae4-7f85-44e3-8ff8-dee2cffdc7ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "137bcddb-ce2b-4a44-9504-1a5fb82e640f",
"_parent_code": "sample string 6",
"sales_organization_id": "432a1f08-884b-4941-a4dd-15e5321abc68",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
},
"equipment_model_id": "89a61f53-1d4f-4fc4-b7f9-d441a9d8cb5d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b5aa692-c84d-4fa7-806a-7032f9c2bf5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7405f444-7d08-47c6-8ce9-b329fac6cd93",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "839ce9ed-e1fe-40e8-b1c6-9e04db3aa040",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "95f9dd20-e682-49d2-b728-e68736a1c5c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
},
"equipment_family_id": "5a3771d2-a35e-488b-92ac-106d089dc913",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2f0bfae4-7f85-44e3-8ff8-dee2cffdc7ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "137bcddb-ce2b-4a44-9504-1a5fb82e640f",
"_parent_code": "sample string 6",
"sales_organization_id": "432a1f08-884b-4941-a4dd-15e5321abc68",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
},
"date_in_production_since": "2024-04-17T15:06:38.9065379+00:00",
"date_out_of_production_since": "2024-04-17T15:06:38.9065379+00:00",
"date_end_support": "2024-04-17T15:06:38.9065379+00:00",
"sales_organization_id": "033fe73f-e181-4773-9f93-14a0d64f9503",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+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-04-17T15:06:38.9065379+00:00"
},
"project_status_id": "e8f0312e-2a93-4e1d-a237-0707b0936d3c",
"project_status_code": "sample string 10",
"project_status": {
"id": "193368d1-624f-47f0-8a7d-5afac256b128",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7e87f4eb-cb13-43a2-8c52-43591e317d42",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
},
"company_id": "335eab5d-3215-4730-b706-ec8c21fad78b",
"company_code": "sample string 12",
"db_address_id": "b43130cc-028b-49ae-84b1-69c3cd981ffb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5db8326b-a0d7-46df-b30b-7aa8a4f29680",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "72a3957a-063f-4d64-8870-143f84473874",
"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-04-17T15:06:38.9065379+00:00",
"date_create": "2024-04-17T15:06:38.9065379+00:00",
"date_update": "2024-04-17T15:06:38.9065379+00:00",
"updated_by_user_id": "48155c71-9da3-400f-bd19-7062a692a8b7",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-17T15:06:38.9065379+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-04-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-17T15:06:38.9065379+00:00",
"date_last_job": "2024-04-17T15:06:38.9065379+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-17T15:06:38.9065379+00:00",
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00",
"is_mobile_installation": true
},
"job_type_id": "5b55b9ed-d5e1-48d8-acca-64caafaf747f",
"job_type_code": "sample string 7",
"job_type": {
"id": "7c4da523-284d-43dc-b0c2-3c6c40280849",
"name": "sample string 2",
"sales_organization_id": "f70fadd5-27e4-42c0-8f22-ec411167ce60",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00",
"code": "sample string 7"
},
"job_priority_id": "4bc4b97c-113d-469c-8fe2-af110bc34e68",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7ce78356-04bf-430d-aac7-9ee4b591012b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9d7f5b23-be74-42f4-8ccc-4b587d700cb6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
},
"job_status_id": "5c140e7e-63ec-464a-a876-de82b7cc26f2",
"job_status_code": "sample string 11",
"db_address_id": "486ae339-041c-4b09-9c5f-0fb33cfade8a",
"contact_id": "f6dfbb71-659a-45f3-936c-bb3deeb4199e",
"requested_by_company_id": "c66e8552-8c0d-49e9-8b41-9e64310b166e",
"requested_by_contact_id": "e2627208-87be-466a-8a73-a7df25122cbd",
"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-04-17T15:06:38.9065379+00:00",
"due_date": "2024-04-17T15:06:38.9065379+00:00",
"date_create": "2024-04-17T15:06:38.9065379+00:00",
"date_update": "2024-04-17T15:06:38.9065379+00:00",
"date_closed": "2024-04-17T15:06:38.9065379+00:00",
"suggested_user_id": "ceb976f9-2d1d-4fdd-8bab-14a9c699a9d6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2031f6a6-3c7a-40c9-880f-539961863884",
"db_language_id": "f8f96cd6-207d-4cf9-b6b5-54ec97e0fc47",
"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-04-17T15:06:38.9065379+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7fdcb719-902e-4f92-b2d3-52332d50ede0",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5445d74f-6b49-489d-a6ae-1bf32097d753",
"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": "fc71529a-64cc-4a20-905a-e48b72c64918",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a47ac45d-e20d-47cd-8cdd-4229ecd04d89"
},
"suggested_date_start": "2024-04-17T15:06:38.9065379+00:00",
"skill_id": "b7a1722d-f3e2-468b-94b6-bb36ac860cc0",
"skill_code": "sample string 32",
"skill": {
"id": "f008d1af-0f0b-40fa-8037-94583995068e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "23392468-ce11-446a-a287-2bab63e48d6d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb16efcf-5ea7-4c00-af52-fdf12b32b116",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdd37df4-bf14-448a-95fd-bf7f28050e99",
"db_currency_id": "ceeb8214-8280-49fb-9264-f1c04f3cdcdc",
"db_language_id": "3e49eb27-c164-4126-99e2-585f6370ce6f",
"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-04-17T15:06:38.9065379+00:00"
},
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "62f1e716-86b7-4c9e-aa31-9dc76457b744",
"date_reported_by_company": "2024-04-17T15:06:38.9065379+00:00",
"id2": 36,
"company_id": "069e265c-fcf0-45f6-8ded-dddfffef7575",
"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": "300b69b5-11ef-480f-bfc3-c1dc328f78ac",
"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-04-17T15:06:38.9065379+00:00"
},
"work_instruction_details_id": "b6aefb5e-c68c-4209-9720-44267450e947",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c0dc2d29-53f2-4194-a66f-de6cab9e48ea",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ebe1c9c6-27e0-422b-9d18-9877e23f5b93",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-17T15:06:38.9065379+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": "dc582090-e917-44cd-b048-9ef191f4478b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-17T15:06:38.9065379+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.