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": "02175655-17fa-4294-a7c7-a02eaeaf1514",
"jobs_id": "21591ace-e4d5-4491-a582-b73e14b5ba81",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cf2fab54-1934-48b7-9335-23362873296a",
"_parent_id": "4d302d0a-7eef-41b2-ab58-4bbc9da8034d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5360c4b7-2f09-4050-b026-c29ed5ebe003",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a1ee5b97-855a-4f95-9036-2b3c7483b792",
"_parent_id": "ca402dc3-f35e-4c3d-9cd3-2c3f2d5ce746",
"root_parent_id": "58cf2feb-4933-43b7-a8c4-3f518e9979bc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8f541778-6d2b-44cd-b462-f2b23b181df2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "829d9823-1b64-4171-8f6f-b8727f4f1e44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "645476af-ce56-453b-960a-89d249e7891f",
"_parent_code": "sample string 6",
"sales_organization_id": "b2533522-44bf-457f-9e07-6dff79238309",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"modified_dateutc": "2023-03-28T03:51:22.6706981+00:00"
},
"equipment_model_id": "96bc245f-9943-477f-b203-6326c427bbfb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6ea92de4-98ed-4069-b88d-c43161decbd0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4f763b29-a0db-4024-b348-3909ca050085",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8c089cdd-1a98-4b8c-a6a6-43a90ec8e8d4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "761b643a-36d6-4ad6-9a53-4a341817b5e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"modified_dateutc": "2023-03-28T03:51:22.6706981+00:00"
},
"equipment_family_id": "2345a938-d859-4317-ae2b-5e9515ea3c55",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "829d9823-1b64-4171-8f6f-b8727f4f1e44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "645476af-ce56-453b-960a-89d249e7891f",
"_parent_code": "sample string 6",
"sales_organization_id": "b2533522-44bf-457f-9e07-6dff79238309",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"modified_dateutc": "2023-03-28T03:51:22.6706981+00:00"
},
"date_in_production_since": "2023-03-28T03:51:22.6706981+00:00",
"date_out_of_production_since": "2023-03-28T03:51:22.6706981+00:00",
"date_end_support": "2023-03-28T03:51:22.6706981+00:00",
"sales_organization_id": "5e88927e-832e-4da9-80be-049e7f733d4a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+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-28T03:51:22.6863301+00:00"
},
"project_status_id": "9c6fc346-f70f-408a-aefb-ed3fd53fa682",
"project_status_code": "sample string 10",
"project_status": {
"id": "b576d396-5229-4d0b-8133-4e9ed56d0a02",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "709baed4-6cfb-4d14-a490-7297e1245540",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00"
},
"company_id": "371bb8f9-fd8d-4969-bdf3-d049c6ae4ec9",
"company_code": "sample string 12",
"db_address_id": "113ba230-82fa-4949-8973-f7988e6cf3b5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c7270a61-21c5-4396-ae77-962cd62ea59f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5217c02a-14b0-4bf2-bbec-b4205a5fe83f",
"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-28T03:51:22.6863301+00:00",
"date_create": "2023-03-28T03:51:22.6863301+00:00",
"date_update": "2023-03-28T03:51:22.6863301+00:00",
"updated_by_user_id": "c04fc08f-55d3-4af5-bffd-51adecf1e494",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-03-28T03:51:22.6863301+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-03-28T03:51:22.6863301+00:00",
"date_last_job": "2023-03-28T03:51:22.6863301+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-03-28T03:51:22.6863301+00:00",
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00",
"is_mobile_installation": true
},
"job_type_id": "5a73212d-298b-42e8-8f81-328f1e52a4e6",
"job_type_code": "sample string 7",
"job_type": {
"id": "abe77dc5-110e-4ee2-b7af-17ba53f6b7b4",
"name": "sample string 2",
"sales_organization_id": "d8ddbe49-2a77-47de-bfc0-1583e6929711",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00",
"code": "sample string 7"
},
"job_priority_id": "19064889-397d-4a1a-943d-7347c4858d69",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "232098ac-55ef-4a9d-a164-dc16dc1e2105",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dae21a5f-9694-4461-9e32-15209171ff0e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00"
},
"job_status_id": "75a39217-db96-4115-ad82-a8bde5807d21",
"job_status_code": "sample string 11",
"db_address_id": "f670dd25-9fe2-4976-8e6c-b1efa422fa39",
"contact_id": "96ec0f84-1846-4c45-97f7-cbd34d031938",
"requested_by_company_id": "0630a1c9-d2bc-447b-adb2-bb6bd4baa59b",
"requested_by_contact_id": "116f861c-8982-4882-9b4a-987fdaf353c1",
"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-28T03:51:22.6863301+00:00",
"due_date": "2023-03-28T03:51:22.6863301+00:00",
"date_create": "2023-03-28T03:51:22.6863301+00:00",
"date_update": "2023-03-28T03:51:22.6863301+00:00",
"date_closed": "2023-03-28T03:51:22.6863301+00:00",
"suggested_user_id": "bf40555c-e6e3-454f-9627-20c653bb04bd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "972065fc-0d0a-4408-a33a-75de047873a9",
"db_language_id": "0f7252e7-df2e-4087-ab42-54e7b1705f15",
"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-28T03:51:22.6863301+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2befa5d0-cca1-4d44-8590-b5541836642c",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ca1d1008-f6c2-43cb-a73d-b7fa63b27972",
"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": "f7bb8bf0-4028-4bc5-b670-79cd8f8520e2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "878870c7-2d22-4621-8ed1-1913edb376b5"
},
"suggested_date_start": "2023-03-28T03:51:22.6863301+00:00",
"skill_id": "883816be-625f-4a36-babb-e659cc288a1a",
"skill_code": "sample string 32",
"skill": {
"id": "ac27010b-c736-4bd3-b8a2-f784fe3195a5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ffba177c-1515-489f-88ab-ae9b6412d811",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6218f84-654a-4ceb-876c-bfe3be2e8379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89da80be-a3cc-4611-a8a6-d9d6bce67196",
"db_currency_id": "0f21421c-d8c7-42f9-8200-15f65b90f2d0",
"db_language_id": "18f50b3b-5574-4fe2-8280-df59303d2670",
"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-28T03:51:22.6706981+00:00"
},
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "89159641-0a65-4834-b1f9-c18b7bf2aaf9",
"date_reported_by_company": "2023-03-28T03:51:22.6863301+00:00",
"id2": 36,
"company_id": "a6754be7-3ae0-4d6c-8015-bf3319f1387d",
"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": "40195238-3f63-4acc-8e08-c2c8309d54fb",
"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-28T03:51:22.6863301+00:00"
},
"work_instruction_details_id": "da362f76-f705-4a5c-b2f4-241d27a644a3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fc707c04-1be0-4024-a44a-8b4d39f3b349",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6a95887b-ea2a-4c62-b166-62567f5b4052",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-03-28T03:51:22.6863301+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": "9f50c5e1-8ef3-4bc0-ab64-dd540409e517",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-03-28T03:51:22.6863301+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.