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": "852ea01b-2553-4ab4-a42d-defdcb8d34d8",
"jobs_id": "857641bf-0b6a-4a1e-9156-1fc3ef65f5c4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "779094e4-86f8-4272-abea-93e7a2da3712",
"_parent_id": "d1596e77-16ff-4c55-9bab-f60399d5bd2b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6a99e6da-7393-4486-9757-2850c3ba1227",
"project_reference_back_office": "sample string 5",
"project": {
"id": "254c85f1-4ccc-442e-9d7b-224bb6aab094",
"_parent_id": "15d721f8-6fdb-43a4-aea7-0c116d51e79f",
"root_parent_id": "5f45c563-384d-4689-95f4-51addcacd581",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a73550ae-547a-4643-9be6-fafa9d287c98",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "37f8fb0f-b085-426c-9fa6-f9bc7b88fff7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50fc77ac-dd1b-4eae-8d06-5ccf72f0029c",
"_parent_code": "sample string 6",
"sales_organization_id": "329262d3-d6d2-4f08-876f-0e5b0b18b908",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00"
},
"equipment_model_id": "970b9031-96d0-4808-a1a7-7b49cca9d85d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8922c4bb-b5e4-4fc8-8b57-9a16d716ee7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "184c4ed9-b114-47e7-ba14-15532512de89",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e7a13793-0b4c-4b07-beee-77184964e644",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "91e3310e-12ea-4eac-ab2f-a49d3f0ac4f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00"
},
"equipment_family_id": "5c75bc9b-c80a-4c29-a3e9-5bf86771ae13",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "37f8fb0f-b085-426c-9fa6-f9bc7b88fff7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50fc77ac-dd1b-4eae-8d06-5ccf72f0029c",
"_parent_code": "sample string 6",
"sales_organization_id": "329262d3-d6d2-4f08-876f-0e5b0b18b908",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00"
},
"date_in_production_since": "2025-02-05T06:58:46.6981178+00:00",
"date_out_of_production_since": "2025-02-05T06:58:46.6981178+00:00",
"date_end_support": "2025-02-05T06:58:46.6981178+00:00",
"sales_organization_id": "275da246-8023-4793-ab92-855180f34898",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+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-02-05T06:58:46.6981178+00:00"
},
"project_status_id": "fff16c6a-eac2-480e-bcc6-e1564ecfc721",
"project_status_code": "sample string 10",
"project_status": {
"id": "ee666fe1-7886-4576-9c17-5b785e21741a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "12b496b0-8e2f-4244-93b2-03fbd3758004",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00"
},
"company_id": "33cdea8c-23e1-4661-97f2-ff830e4464f7",
"company_code": "sample string 12",
"db_address_id": "d2778ee5-5bcc-4942-9e11-d69118b37d97",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cfaa1618-d355-42c6-94b0-2129e6ea9829",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7139d8bd-9b96-4df1-bea4-a1224b36f54e",
"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-02-05T06:58:46.6981178+00:00",
"date_create": "2025-02-05T06:58:46.6981178+00:00",
"date_update": "2025-02-05T06:58:46.6981178+00:00",
"updated_by_user_id": "e7a47c34-a7c9-4c23-ab00-ffb6b15878f0",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-02-05T06:58:46.6981178+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-02-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-02-05T06:58:46.6981178+00:00",
"date_last_job": "2025-02-05T06:58:46.6981178+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-02-05T06:58:46.6981178+00:00",
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00",
"is_mobile_installation": true
},
"job_type_id": "8f04db6e-bf4b-4e5b-9347-c3836eccbb92",
"job_type_code": "sample string 7",
"job_type": {
"id": "ed3cd734-3a23-42f4-8fc3-bb57a4979822",
"name": "sample string 2",
"sales_organization_id": "534b28ca-5f8c-45ba-a317-0f37b88aad4c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00",
"code": "sample string 7"
},
"job_priority_id": "459b7f3b-a2a5-4152-b712-20e4fe7a6fff",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f11c9df5-0f2b-4870-99a7-2e3d38f969da",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f79205ea-7a4f-444f-ab58-2856e302b6dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-05T06:58:46.6981178+00:00"
},
"job_status_id": "23df3f9c-8577-46f5-b2ab-77e165cc0426",
"job_status_code": "sample string 11",
"db_address_id": "0898312e-8e67-4556-bbf1-6c36394b2242",
"contact_id": "ed72cd93-dad1-4227-af9f-000227432786",
"requested_by_company_id": "f580099c-a0b2-4993-8b70-0951f8049335",
"requested_by_contact_id": "e2839f5d-7f62-4481-ae32-0724cb247c39",
"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-02-05T06:58:46.7137442+00:00",
"due_date": "2025-02-05T06:58:46.7137442+00:00",
"date_create": "2025-02-05T06:58:46.7137442+00:00",
"date_update": "2025-02-05T06:58:46.7137442+00:00",
"date_closed": "2025-02-05T06:58:46.7137442+00:00",
"suggested_user_id": "8d10ead6-28c9-4df0-ae75-5391697d1dd1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2b01cf3d-0ca3-46ff-a737-9385b8ebce4b",
"db_language_id": "94b23d8d-0e51-4e22-bb52-8b659dfe0e7a",
"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-02-05T06:58:46.7137442+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "39250d9e-da92-43bf-a7a4-26688f59a0b1",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08bce49b-3e91-41e3-a73a-46ea11879f31",
"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": "438f54ce-94cf-4b4d-b1b8-93309a7a55ee",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-02-05T06:58:46.7137442+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f422b613-71d5-447c-b554-554000f6962a"
},
"suggested_date_start": "2025-02-05T06:58:46.7137442+00:00",
"skill_id": "d2c7423b-6418-4170-8c41-cc86f56fb8bd",
"skill_code": "sample string 32",
"skill": {
"id": "4f8654cb-4f67-4d2c-a36c-3230a128821d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b292c114-1bcc-4f1f-a129-d852b1c9dbf6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55b24e46-31c3-4972-82ad-b07e54a3ecf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bd0a7b6-a05e-4c09-b8dc-d6ebb01bad96",
"db_currency_id": "afa545f4-5525-42eb-9b3f-f845ebb36e91",
"db_language_id": "ed36da9b-b56d-491d-a928-7c7778fa1c7e",
"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-02-05T06:58:46.6981178+00:00"
},
"modified_dateutc": "2025-02-05T06:58:46.7137442+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8ebeef3c-d137-4a1b-976f-1196cf8edacd",
"date_reported_by_company": "2025-02-05T06:58:46.7137442+00:00",
"id2": 36,
"company_id": "3dc26d39-ae45-407f-b84f-7538ff449641",
"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": "861f3853-843d-414b-8c34-53ebbeccf0fb",
"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-02-05T06:58:46.7137442+00:00"
},
"work_instruction_details_id": "828cc902-2d03-4fa9-bab8-d8c854de6adf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f88a99a0-9a01-4428-9cec-c1f783301c4b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0566212a-614f-42e9-ab7a-7ab4ec0c3d5c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-02-05T06:58:46.7137442+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": "95de4c8b-6121-48bb-b699-bae3b7e9ba96",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-02-05T06:58:46.7137442+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.