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": "0ed6905d-c324-4b64-98cd-524bcdf7935d",
"jobs_id": "c23fef38-b2da-4f4f-8b4e-11430b6b4526",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "98d6e4b4-5c33-400b-a144-02668bf65aad",
"_parent_id": "8b777c51-be07-44b4-a9a8-a19680b9ab81",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf38ddeb-e06b-4779-9dfa-8f46263a10e6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "17c91ab8-3871-4bc5-b5eb-2e2f0b22367f",
"_parent_id": "063e0950-8d8e-4e0e-98ae-b918e257763a",
"root_parent_id": "a101135f-8acb-4e63-ba65-5babba8bdf90",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "de8692c8-337f-49e4-9005-147f202203fe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "80458d16-8b26-4ee7-af84-ff187bcd8924",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "44792da0-31cc-4fa6-bb8e-8e5784e3204f",
"_parent_code": "sample string 6",
"sales_organization_id": "565d2140-6f94-462d-982d-68d20a2e38a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
},
"equipment_model_id": "fbef423c-c605-4452-9133-3c0dae7b750c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ce06d253-1314-4bdf-8453-9463db991599",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c25713a4-5dce-4b31-8688-b4b1d09c9f40",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3097066b-5a0a-4bae-bdff-21e7626b0114",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1a62f791-d28e-4f7a-863b-59bbe7fd787c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
},
"equipment_family_id": "c0d547da-0b33-4d3b-a5a4-11f0cc9f6f77",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "80458d16-8b26-4ee7-af84-ff187bcd8924",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "44792da0-31cc-4fa6-bb8e-8e5784e3204f",
"_parent_code": "sample string 6",
"sales_organization_id": "565d2140-6f94-462d-982d-68d20a2e38a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
},
"date_in_production_since": "2025-03-28T13:36:26.4378661+00:00",
"date_out_of_production_since": "2025-03-28T13:36:26.4378661+00:00",
"date_end_support": "2025-03-28T13:36:26.4378661+00:00",
"sales_organization_id": "1144a43e-cbc3-478c-bdf1-b6484a93af06",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+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-03-28T13:36:26.4378661+00:00"
},
"project_status_id": "f091c879-8c91-466a-9a32-fafaf806d5e1",
"project_status_code": "sample string 10",
"project_status": {
"id": "d83c4beb-e1f3-41c6-914d-0f919d100e98",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "57465a4e-9327-4429-8775-f2530851c4af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
},
"company_id": "401ed29b-5c4b-44dd-ae50-9b8d8b794c39",
"company_code": "sample string 12",
"db_address_id": "aa94ad4d-e81c-4e76-8f77-2cda16451c6e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2b53f4b5-9d61-4095-8a1f-d6b1df2e5bda",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3fb7fbdd-8ae7-4e45-87d7-23c1857cda96",
"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-03-28T13:36:26.4378661+00:00",
"date_create": "2025-03-28T13:36:26.4378661+00:00",
"date_update": "2025-03-28T13:36:26.4378661+00:00",
"updated_by_user_id": "1931734a-30a9-45be-8ae4-aa4c7b1c89f8",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-28T13:36:26.4378661+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-03-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-28T13:36:26.4378661+00:00",
"date_last_job": "2025-03-28T13:36:26.4378661+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-28T13:36:26.4378661+00:00",
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00",
"is_mobile_installation": true
},
"job_type_id": "2ef669cb-51d4-4730-b747-744ab08fc30e",
"job_type_code": "sample string 7",
"job_type": {
"id": "3e470594-0a46-4882-a9d7-134bbb8ff65e",
"name": "sample string 2",
"sales_organization_id": "91341f2b-9d0a-408f-b235-a51970d634d5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00",
"code": "sample string 7"
},
"job_priority_id": "8f016881-ed58-4d9a-9b95-2ce2c654fbf1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2a87e4f4-9ceb-44d4-bf3a-de63298293f1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "431a648e-20e2-4a1a-a9c6-528c8b7873b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
},
"job_status_id": "8ef345cb-aeea-4143-a445-5b0f53769e48",
"job_status_code": "sample string 11",
"db_address_id": "3a8bf033-c454-4549-97b4-a074128d9c85",
"contact_id": "f6d158fa-f270-425a-8f96-c7f9de674300",
"requested_by_company_id": "e53a4604-2198-41fa-a348-9c8c75ea170f",
"requested_by_contact_id": "2965426e-2713-4d8f-ac84-fa84e4f78449",
"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-03-28T13:36:26.4378661+00:00",
"due_date": "2025-03-28T13:36:26.4378661+00:00",
"date_create": "2025-03-28T13:36:26.4378661+00:00",
"date_update": "2025-03-28T13:36:26.4378661+00:00",
"date_closed": "2025-03-28T13:36:26.4378661+00:00",
"suggested_user_id": "6bbf9064-4ee1-4b89-b980-c60cb661e80c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5c330575-271f-48e8-848b-36d140c6b0ac",
"db_language_id": "a31034a4-ce29-4e8f-9d47-039baa11c8a5",
"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-03-28T13:36:26.4378661+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7549558c-ac36-4416-af24-2329c9575e3b",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f111c85c-df98-47c5-a51a-428a88da51c9",
"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": "7f147262-d520-4437-9e4f-554f9796af40",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2d0c8c58-7001-4a1e-baf2-996e2ea850fa"
},
"suggested_date_start": "2025-03-28T13:36:26.4378661+00:00",
"skill_id": "663a0043-2603-4cfe-b035-b09cc960f62c",
"skill_code": "sample string 32",
"skill": {
"id": "01a9c7f6-2705-4a64-9dae-3a758848185c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8b511f5a-03b5-4a57-a280-70eee120d353",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1be38d6e-40b1-4ec3-8ee9-635f484a18b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0b9a977-13db-4ded-821a-2dcb3fb0378a",
"db_currency_id": "081254fe-7dd5-4ae7-a18e-dae4000d1c83",
"db_language_id": "9db3cc81-33b4-44ae-b6b8-601c1fc62aba",
"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-03-28T13:36:26.4378661+00:00"
},
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "07c275f7-7779-40aa-8eec-5427baf7f231",
"date_reported_by_company": "2025-03-28T13:36:26.4378661+00:00",
"id2": 36,
"company_id": "c1021122-7f51-4298-bc3c-1db4d288051d",
"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": "08f6bf5d-b8a7-4378-8c3f-9a53e8188412",
"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-03-28T13:36:26.4378661+00:00"
},
"work_instruction_details_id": "87b16ee4-7c84-4c1c-88fc-719bb8a5dc00",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f52073b7-3284-485f-be19-adff50ba2a0c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "df3a581e-1d95-4be4-8902-6f0d7b51276b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-28T13:36:26.4378661+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": "fa29d9c4-ae43-4ddf-8cce-74a03c5e9a6f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-28T13:36:26.4378661+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.