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": "7f6c2e6c-8ae1-474e-a0af-44fb3d62aa84",
"jobs_id": "85b1b1f2-21d2-4700-976a-b9bd63064e42",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "25955571-4589-48e8-acf1-925dc510b370",
"_parent_id": "b25633d0-7c1f-4cda-b075-30751bd92b3b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7d6b15df-cd09-4171-a36c-8cd183bcde35",
"project_reference_back_office": "sample string 5",
"project": {
"id": "840a60fc-2570-4774-9636-18dd690abc24",
"_parent_id": "7a66da41-8ad2-43ad-a4bc-a9c2b17c14c2",
"root_parent_id": "00503458-6c4d-41a1-829d-c2873bda0766",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1cb854d7-1056-469b-9a54-ebe129cb2668",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c63eebb9-8469-4223-a829-28d5ac4bf88d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a9f7323-d2d7-44c2-89f5-a8931113195b",
"_parent_code": "sample string 6",
"sales_organization_id": "92013e98-210c-467e-944b-772095a08161",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00"
},
"equipment_model_id": "5f743706-b08c-4bd9-ba97-62f8ebebc7a7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b2fee278-ddf5-4457-aaeb-f75e91473eed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9bcff2ae-d577-4f21-a4ac-ee46fd312e35",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7f38d41f-b597-4748-b352-10226fad4599",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5fb370f8-a055-4726-aeee-db674d418804",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00"
},
"equipment_family_id": "087519c4-8c5f-4c0f-b85b-a38659bf9155",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c63eebb9-8469-4223-a829-28d5ac4bf88d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a9f7323-d2d7-44c2-89f5-a8931113195b",
"_parent_code": "sample string 6",
"sales_organization_id": "92013e98-210c-467e-944b-772095a08161",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00"
},
"date_in_production_since": "2024-04-22T01:50:25.9123271+00:00",
"date_out_of_production_since": "2024-04-22T01:50:25.9123271+00:00",
"date_end_support": "2024-04-22T01:50:25.9123271+00:00",
"sales_organization_id": "82c57ff1-69fb-468e-a8b1-a1d3e4720df9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+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-04-22T01:50:25.9123271+00:00"
},
"project_status_id": "31a8af8c-c311-423f-beae-d9d84d644060",
"project_status_code": "sample string 10",
"project_status": {
"id": "289103ca-daab-4768-89c7-85c46c84a996",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e46b158e-97a9-479a-b2f5-24e74a4b3f8a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00"
},
"company_id": "a30054c9-cf2f-4e96-8acf-89a99b3386f2",
"company_code": "sample string 12",
"db_address_id": "693709ce-1c8f-4265-ab42-3d3c9593e584",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "17572e7f-a64c-4484-9fc3-670245c24cb3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2deaaa0a-4d14-4b97-bf5f-d89d2ce415b2",
"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-04-22T01:50:25.9123271+00:00",
"date_create": "2024-04-22T01:50:25.9123271+00:00",
"date_update": "2024-04-22T01:50:25.9123271+00:00",
"updated_by_user_id": "9cd7348d-0470-4439-806b-d6202ed6f4e5",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-22T01:50:25.9123271+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-04-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-22T01:50:25.9123271+00:00",
"date_last_job": "2024-04-22T01:50:25.9123271+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-22T01:50:25.9123271+00:00",
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00",
"is_mobile_installation": true
},
"job_type_id": "87b46018-65af-40a3-bc0f-b4cea072a33f",
"job_type_code": "sample string 7",
"job_type": {
"id": "56e18ade-d3a0-431e-a012-154901f49319",
"name": "sample string 2",
"sales_organization_id": "e0081770-ab6c-4cee-9ae4-f4f7266d89c6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00",
"code": "sample string 7"
},
"job_priority_id": "e8908de0-9232-426e-9028-9580bd9ea4a2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b5ca550d-f89c-4f61-b921-ec749d7f885b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d75f9e33-0065-400e-a561-03c3b7e02b5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T01:50:25.9123271+00:00"
},
"job_status_id": "30355ac1-fc16-4637-b87b-e262a94baa69",
"job_status_code": "sample string 11",
"db_address_id": "04d401e0-b2c9-4123-8613-f41b7de08db9",
"contact_id": "42e30e1f-0802-470e-acad-0f47bbf65d06",
"requested_by_company_id": "d1c19e4d-df2b-45e7-a046-542b7c522b6e",
"requested_by_contact_id": "47c89517-0248-4af5-8a66-57a35852b476",
"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-04-22T01:50:25.9279552+00:00",
"due_date": "2024-04-22T01:50:25.9279552+00:00",
"date_create": "2024-04-22T01:50:25.9279552+00:00",
"date_update": "2024-04-22T01:50:25.9279552+00:00",
"date_closed": "2024-04-22T01:50:25.9279552+00:00",
"suggested_user_id": "2f3a4c02-a164-4165-9c7d-f970805de726",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "90c091ab-dbba-4a75-89ee-d9d1ef7892c6",
"db_language_id": "1755f2f4-ce06-4ca3-a5f2-e41eeba26504",
"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-04-22T01:50:25.9279552+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "05422ca8-053e-4777-ab5b-98db69c1c7dd",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5f6ca6ca-6f66-4e28-bad0-63856dcb76b9",
"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": "2a2951c2-64ab-4525-a4e8-594b255a0d2a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-22T01:50:25.9279552+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "efe58f16-59cb-4119-b0e8-0b61fdcf25f0"
},
"suggested_date_start": "2024-04-22T01:50:25.9279552+00:00",
"skill_id": "20f5fa40-7100-44a6-a66a-aa1309474fc3",
"skill_code": "sample string 32",
"skill": {
"id": "50936590-eafa-4108-b59b-a39d9ba32049",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ed0ce0ef-d7db-41a1-9a1d-7a517ce46113",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a568915d-448b-470d-bd65-51f0506de4f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2d658cd-1490-4412-a804-de6802464938",
"db_currency_id": "fb7ea8c0-5d37-4b09-a972-db3069d55131",
"db_language_id": "5036ac4c-2436-4d09-add8-ca76a64ccf9a",
"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-04-22T01:50:25.9123271+00:00"
},
"modified_dateutc": "2024-04-22T01:50:25.9279552+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "33f4bf1d-8ab7-4c9f-8f3c-726271789108",
"date_reported_by_company": "2024-04-22T01:50:25.9279552+00:00",
"id2": 36,
"company_id": "5a70762b-7e35-4402-9cd3-05c5d09edf99",
"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": "6ff72fb8-4030-42bb-8dc1-7e0a89240f91",
"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-04-22T01:50:25.9279552+00:00"
},
"work_instruction_details_id": "12011010-ac8d-4142-bdef-188233af14fa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5cbd0b6f-dfea-44b8-a393-baa59061134b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7ea0d269-6df3-40d1-925e-9bdfa0c13cb0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-22T01:50:25.9279552+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": "5e8b6da4-4ed3-4bff-a353-a1f6ba75e313",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-22T01:50:25.9279552+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.