Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "c81ea037-3ecb-4c70-8317-c10fec9c013c",
"jobs_id": "4faae369-8ded-4331-a032-7233fa347a6c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "500486dc-f531-4118-80a1-0706f1864f17",
"_parent_id": "1923afb4-7d0d-4b3a-a156-b8145f8f1af6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b26206b8-19f0-45b6-aa5a-fdf9179e062a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "35055763-147d-4517-82fe-60268ce66305",
"_parent_id": "cdc144de-9ae2-45fb-94d2-66f4ef01718a",
"root_parent_id": "5917a6d4-c4de-47b3-a34f-a6e13e57813b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "56a1ccd8-6c99-47ba-9ed9-874c4daa5e24",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9dcaeb4c-6c57-46e5-82d3-f43f86f2693c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0879410-8262-4a9b-80e2-f04e16d43d87",
"_parent_code": "sample string 6",
"sales_organization_id": "40722ac2-6444-4d09-bf98-f384c6f84720",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"modified_dateutc": "2024-12-26T07:28:12.3619838+00:00"
},
"equipment_model_id": "be9dbfe2-746e-4d6d-8057-b6fd7c3475dc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "90cf5625-ae49-4647-a8cd-351ecbbacd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d6bc80d9-ed30-45a2-a8ab-7c5a56a65c08",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8eef8431-9766-49cf-b439-0561de41aa11",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "97e7c125-1fee-40dc-9c8a-faa5e6667635",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"modified_dateutc": "2024-12-26T07:28:12.3619838+00:00"
},
"equipment_family_id": "60c5b6ac-46d4-4f38-8047-cb90b8dc7083",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9dcaeb4c-6c57-46e5-82d3-f43f86f2693c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0879410-8262-4a9b-80e2-f04e16d43d87",
"_parent_code": "sample string 6",
"sales_organization_id": "40722ac2-6444-4d09-bf98-f384c6f84720",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"modified_dateutc": "2024-12-26T07:28:12.3619838+00:00"
},
"date_in_production_since": "2024-12-26T07:28:12.3619838+00:00",
"date_out_of_production_since": "2024-12-26T07:28:12.3619838+00:00",
"date_end_support": "2024-12-26T07:28:12.3619838+00:00",
"sales_organization_id": "6b554639-0be0-4a6a-a1bf-92a207a3fb7c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+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-26T07:28:12.3619838+00:00"
},
"project_status_id": "c57e26b9-11dc-48b4-b53a-2a0d1311090e",
"project_status_code": "sample string 10",
"project_status": {
"id": "74b0d88c-9dd3-40df-ac3f-25dd5d3ed78d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e85f7e25-6492-4a89-aa6f-ec40a6f36859",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-26T07:28:12.3619838+00:00"
},
"company_id": "f23ba8c7-d802-4f75-a755-daa7e16b401f",
"company_code": "sample string 12",
"db_address_id": "1fa603d2-af02-4b90-b136-a863ea3d71c2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b22514e2-4f00-42ee-87d4-64a7739a0763",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ae352b56-321f-453d-85f3-da0c9f2c2cd6",
"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-26T07:28:12.3619838+00:00",
"date_create": "2024-12-26T07:28:12.3619838+00:00",
"date_update": "2024-12-26T07:28:12.3619838+00:00",
"updated_by_user_id": "ea4e87f6-bd32-46c3-9c5a-17def013277a",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-26T07:28:12.3619838+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-26T07:28:12.3776039+00:00",
"date_last_job": "2024-12-26T07:28:12.3776039+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-26T07:28:12.3776039+00:00",
"modified_dateutc": "2024-12-26T07:28:12.3776039+00:00",
"is_mobile_installation": true
},
"job_type_id": "79446500-9b1a-403e-af96-ce70cd70d330",
"job_type_code": "sample string 7",
"job_type": {
"id": "7ad12c06-3324-4f76-9053-5af9ccfdea4e",
"name": "sample string 2",
"sales_organization_id": "6707f5a2-b3d4-4077-8838-a5bfb004c132",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-26T07:28:12.3776039+00:00",
"code": "sample string 7"
},
"job_priority_id": "a22b047e-49e2-4a19-962d-f437991ce199",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d918cb77-3399-4c1e-8ae7-8be99c153235",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4d0cf110-6477-40b6-b3c8-e3430062398d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-26T07:28:12.3776039+00:00"
},
"job_status_id": "7c88e94e-cd6b-450b-80e3-be553475ffd3",
"job_status_code": "sample string 11",
"db_address_id": "15572d82-3665-472e-a3b5-8e10702d881a",
"contact_id": "d3db0ce4-adc9-4389-b0e8-9c57ea9d70b3",
"requested_by_company_id": "ceeff42c-95fa-4498-9566-4c8f66c93773",
"requested_by_contact_id": "330b3581-cce5-4b6f-8dd3-0b59bcc4d3b2",
"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-26T07:28:12.3776039+00:00",
"due_date": "2024-12-26T07:28:12.3776039+00:00",
"date_create": "2024-12-26T07:28:12.3776039+00:00",
"date_update": "2024-12-26T07:28:12.3776039+00:00",
"date_closed": "2024-12-26T07:28:12.3776039+00:00",
"suggested_user_id": "1cffd2fa-1433-47eb-bc41-4057017caeb1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4a4afe10-88f0-4b88-9278-97238430ff39",
"db_language_id": "2c8907b3-b5cc-402f-adc2-e7f36cdf0777",
"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-26T07:28:12.3776039+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2a0ea1ce-54d5-4fcc-aea9-cb91e9fcc190",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3ddfd703-518e-4f0f-b59b-6fbfd72ef2e3",
"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": "37235196-3333-4677-9ceb-bbf585adcbce",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-26T07:28:12.3776039+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6fabb4c6-35b7-4142-83eb-cc52d8c1f63b"
},
"suggested_date_start": "2024-12-26T07:28:12.3776039+00:00",
"skill_id": "b321a1cc-448f-4ae8-9110-a6dad9c1c54e",
"skill_code": "sample string 32",
"skill": {
"id": "6565d252-5c96-404c-a071-455accf6cbee",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0cdad6de-cce2-4edd-9431-b1d96c6b869a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04d05bda-fcc6-485d-855c-867736fe7042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d714ba35-1e04-433d-b097-4fdf10450b4f",
"db_currency_id": "dc12e951-e663-4bb3-9e07-03b4d91a796f",
"db_language_id": "323db2dc-84d1-4eb0-9c1d-208558935e33",
"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-26T07:28:12.3619838+00:00"
},
"modified_dateutc": "2024-12-26T07:28:12.3776039+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dc418fa1-aef4-4c65-8321-72ba7765da45",
"date_reported_by_company": "2024-12-26T07:28:12.3776039+00:00",
"id2": 36,
"company_id": "bc21a111-4dbe-41e1-b373-c849177c6971",
"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": "57254ba0-d730-4f61-a63f-dddecb9611ad",
"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-26T07:28:12.3776039+00:00"
},
"work_instruction_details_id": "154ff6e1-72ce-465a-a327-583f8dcd4d3f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "847294e0-0e0b-4145-8750-620c7a9a92cf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "521dd339-bd12-411c-9f83-5e5b3bb7bba6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-26T07:28:12.3776039+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": "af57c5ba-743a-4c47-8c4d-1e5a45463f0b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-26T07:28:12.3776039+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.