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": "b4b7f5f0-92fb-4777-8025-27bdf6a32df3",
"jobs_id": "02426dec-a3c3-41d9-be8a-06be9a14bc33",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "025cba93-67b6-4be6-9634-d6d42d53134f",
"_parent_id": "a590d66d-3d33-403c-ada6-3cbfa69c5112",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f1f35568-5e8b-4835-8925-c06dcafa8ad1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4d92194d-dcb8-41db-a2d9-99538a4e3f31",
"_parent_id": "f38c5c8f-26b3-4137-8b42-5bed121b7262",
"root_parent_id": "5e035767-9cad-4b91-9c84-bccc98d17446",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "187d135e-b9ed-4441-b13e-c653108ddeb0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "045d9498-eb1e-45f0-a889-e4235e400748",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae41acea-d171-481f-9ba6-ba632d2c4235",
"_parent_code": "sample string 6",
"sales_organization_id": "b3e97a04-81ed-462c-8948-8cda42abacc0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00"
},
"equipment_model_id": "ae202b31-9134-425b-9bec-8e1ca72b2e72",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cb80e21a-ba3d-4013-b9a7-7d997405da89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1973c910-310f-48ac-add4-a602d002bc9a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5ccdd3b6-1e19-47ac-b2f6-ab450fb311e4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "557006ce-bf5b-42c1-9beb-110aad01c97d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00"
},
"equipment_family_id": "ff5cc22d-169a-45b0-ba6d-8a54d4afae0a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "045d9498-eb1e-45f0-a889-e4235e400748",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae41acea-d171-481f-9ba6-ba632d2c4235",
"_parent_code": "sample string 6",
"sales_organization_id": "b3e97a04-81ed-462c-8948-8cda42abacc0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00"
},
"date_in_production_since": "2024-12-21T13:37:35.5872398+00:00",
"date_out_of_production_since": "2024-12-21T13:37:35.5872398+00:00",
"date_end_support": "2024-12-21T13:37:35.5872398+00:00",
"sales_organization_id": "00a54d51-84f0-4152-8a82-d682e70c83b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+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-12-21T13:37:35.5872398+00:00"
},
"project_status_id": "b710a3b7-ef9b-4927-8c31-0c64323ddf50",
"project_status_code": "sample string 10",
"project_status": {
"id": "b9d58202-6101-4ea0-b10b-52ce5c15e6e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "232c66ef-3887-476b-95d0-384596205616",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00"
},
"company_id": "eef2869e-79f7-4e02-a964-22b7c96b0b76",
"company_code": "sample string 12",
"db_address_id": "3defabab-5020-4425-a138-86c4587a07ed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5dfc3e47-5cf2-4f50-b8cb-19d75f7d79e4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "08bd5ebe-dc1d-4bf8-b4aa-9424f3e504e8",
"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-12-21T13:37:35.5872398+00:00",
"date_create": "2024-12-21T13:37:35.5872398+00:00",
"date_update": "2024-12-21T13:37:35.5872398+00:00",
"updated_by_user_id": "ae2802b2-9633-45ee-87df-2880a5ce0780",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-21T13:37:35.5872398+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-12-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-21T13:37:35.5872398+00:00",
"date_last_job": "2024-12-21T13:37:35.5872398+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-21T13:37:35.5872398+00:00",
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00",
"is_mobile_installation": true
},
"job_type_id": "0a785338-8c49-4a9e-9793-c5cfa604780b",
"job_type_code": "sample string 7",
"job_type": {
"id": "dfedf726-f2e0-4afa-ba75-9d4dd71b2883",
"name": "sample string 2",
"sales_organization_id": "ba14850d-ae04-4d91-8cf6-ed43581ff86f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00",
"code": "sample string 7"
},
"job_priority_id": "a555a43d-7248-4237-b45f-c6afa9bd7c51",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "335c21a5-1c4e-4f18-a0b3-7d49819f46d4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e709a030-5ea9-4e00-b4ed-f8e4ca7ab7a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00"
},
"job_status_id": "9705a036-e55b-4ebb-ac34-9c722556f6a0",
"job_status_code": "sample string 11",
"db_address_id": "454a523a-62f6-4eb6-a688-ca78f45c5d49",
"contact_id": "b22ff051-576a-4f1b-a837-f7f3d04d6a49",
"requested_by_company_id": "034dfc3b-6e59-4789-ad12-93d3434b1aba",
"requested_by_contact_id": "03d3e971-503c-4fcf-9c2d-f21c811e761a",
"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-12-21T13:37:35.5872398+00:00",
"due_date": "2024-12-21T13:37:35.5872398+00:00",
"date_create": "2024-12-21T13:37:35.5872398+00:00",
"date_update": "2024-12-21T13:37:35.5872398+00:00",
"date_closed": "2024-12-21T13:37:35.5872398+00:00",
"suggested_user_id": "b4d7f904-5ed6-4078-9517-3e879f0cddb2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1360bfad-1910-4e28-ba06-192db24dc454",
"db_language_id": "068ece8a-8407-47ea-b6ba-9c45c097ecd9",
"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-12-21T13:37:35.5872398+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5d0ba70b-d29d-4c23-9539-a4750c961b61",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7389c429-2a87-432e-a146-90ef78dd2e66",
"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": "c595fbcd-685a-4e5b-8afb-68ba992807ba",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9edf3a35-042e-4176-9bb7-72ca9360d81c"
},
"suggested_date_start": "2024-12-21T13:37:35.5872398+00:00",
"skill_id": "18a31648-fc15-4237-99dc-8478d2e0c564",
"skill_code": "sample string 32",
"skill": {
"id": "e834cf00-c9ff-4382-9103-f0a9a1015945",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "70de4900-0aad-4589-9701-c7ca89e21e54",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6bc9c34-ed2e-43ec-984d-2c276f4e42b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "249f6ac6-c4de-4b87-82ce-1d49d4991b07",
"db_currency_id": "ba15221d-d77a-4797-8b72-1cb4b5858857",
"db_language_id": "a2b37ff7-1e58-4c90-a2a5-f947f8d757a3",
"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-12-21T13:37:35.5872398+00:00"
},
"modified_dateutc": "2024-12-21T13:37:35.5872398+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "da638d8f-0962-42e3-b896-925c78fa22d6",
"date_reported_by_company": "2024-12-21T13:37:35.5872398+00:00",
"id2": 36,
"company_id": "23092129-96c4-4978-be38-98d943013498",
"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": "764c64b3-a7e8-436a-b24f-fcdc01d0fbbd",
"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-12-21T13:37:35.602868+00:00"
},
"work_instruction_details_id": "97c7bdde-f876-47ab-9e55-b7d76ce6c3d6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "54fd9940-1807-47d1-a1c1-1da577f4be5e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "51cb9a1c-0885-4d3c-859d-b5b73a58df56",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-21T13:37:35.602868+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": "eb0da24e-e0c3-4f3e-9cb5-b83dc9a2eb01",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-21T13:37:35.602868+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.