Updates the job work instruction list with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional 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": "1a1c102b-e08b-4de5-8b48-4e08dc512891",
  "jobs_id": "b38cd608-1565-4cdb-aeb2-b36b782ff6b0",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "764b045d-32fa-42ff-89b5-d59c693b9a1d",
    "_parent_id": "824f749d-90b6-44e6-8554-9f0888b594f9",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "27a5ebe8-fe0c-47e8-9b66-7778831fd914",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "04ace07d-9310-43b6-8ac0-1ea0868c113e",
      "_parent_id": "5c5e9336-e55a-4669-ad20-3c310792c8d6",
      "root_parent_id": "687504bd-a660-487a-8c32-e2fd5bd11746",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "5f822d74-96ae-4968-8e34-c74001202f69",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "aa271f1f-0be8-4e01-b7b1-aeb12e2db1fd",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "5aa09cc1-7be1-402e-aba5-2345d030a70f",
        "_parent_code": "sample string 6",
        "sales_organization_id": "21b6ad84-0d69-4723-8fa4-15446ed96b56",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
          "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
          "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
          "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": "2022-12-02T20:26:08.3234204+01:00"
        },
        "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
      },
      "equipment_model_id": "c7517cf6-f4b3-44b1-ab2f-0d8c5381bb92",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "f181b71c-83f2-459f-b2e2-54387cafa3b8",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "e44762c6-8faf-4242-89ef-9363009d1416",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "b570a96d-5fc6-4628-84d8-bac956bfc0e4",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "740a27b2-0bc8-4144-9202-4da6802c35f9",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
            "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
            "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
            "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": "2022-12-02T20:26:08.3234204+01:00"
          },
          "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
        },
        "equipment_family_id": "5cb80c46-beb7-4cd1-a286-b9d166b8a9c8",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "aa271f1f-0be8-4e01-b7b1-aeb12e2db1fd",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "5aa09cc1-7be1-402e-aba5-2345d030a70f",
          "_parent_code": "sample string 6",
          "sales_organization_id": "21b6ad84-0d69-4723-8fa4-15446ed96b56",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
            "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
            "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
            "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": "2022-12-02T20:26:08.3234204+01:00"
          },
          "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
        },
        "date_in_production_since": "2022-12-02T20:26:08.3234204+01:00",
        "date_out_of_production_since": "2022-12-02T20:26:08.3234204+01:00",
        "date_end_support": "2022-12-02T20:26:08.3234204+01:00",
        "sales_organization_id": "77ff3734-fbd7-4d7e-9f15-f31a0379d068",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
          "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
          "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
          "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": "2022-12-02T20:26:08.3234204+01: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": "2022-12-02T20:26:08.3234204+01:00"
      },
      "project_status_id": "11050c81-190e-4861-b758-df80e4d9068d",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "be5f7a4d-d2ca-462a-a5d7-4db0c59080a8",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "22a4c09d-6673-439f-ac99-ade3fa3941ec",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
          "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
          "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
          "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": "2022-12-02T20:26:08.3234204+01:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
      },
      "company_id": "7de07f1f-63b4-4462-8bb4-076996c66e1f",
      "company_code": "sample string 12",
      "db_address_id": "e01770d9-3607-49fa-a9de-ac5bc92e646b",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "711ec2f0-810a-4b78-9d7e-065295429392",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "e3c8cf1c-d6cd-45e0-bb67-1e619994b900",
      "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": "2022-12-02T20:26:08.3234204+01:00",
      "date_create": "2022-12-02T20:26:08.3234204+01:00",
      "date_update": "2022-12-02T20:26:08.3234204+01:00",
      "updated_by_user_id": "4af1cddb-315b-4402-9cfd-80699656be4d",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2022-12-02T20:26:08.3234204+01: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": "2022-12-02T00:00:00+01:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2022-12-02T20:26:08.3234204+01:00",
      "date_last_job": "2022-12-02T20:26:08.3234204+01:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2022-12-02T20:26:08.3234204+01:00",
      "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00",
      "is_mobile_installation": true
    },
    "job_type_id": "d7b0e817-270e-4f9f-a11d-0a4928144899",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "e3f5c222-7c67-4170-bdd3-bce974e2843a",
      "name": "sample string 2",
      "sales_organization_id": "a523f199-f7df-4a75-8876-ef64c3bf1525",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00",
      "code": "sample string 7"
    },
    "job_priority_id": "93398545-9037-4f2f-98a7-37d22b21440e",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "450e1bce-0c70-4e50-bc89-2998976c6b8c",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "f8946722-5098-46cd-8021-6110e619fa0e",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
        "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
        "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
        "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": "2022-12-02T20:26:08.3234204+01:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
    },
    "job_status_id": "50f53b92-8b8d-4872-b024-70988a9bb9c7",
    "job_status_code": "sample string 11",
    "db_address_id": "bf5233ac-a0dc-4079-a21d-f15f6da693a3",
    "contact_id": "3b576061-f1a5-456b-973a-c311305a4003",
    "requested_by_company_id": "155d9f63-e033-427f-b43b-e19571027316",
    "requested_by_contact_id": "e254c1db-0e4d-4cf3-afb8-b75a0fc3fc69",
    "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": "2022-12-02T20:26:08.3234204+01:00",
    "due_date": "2022-12-02T20:26:08.3234204+01:00",
    "date_create": "2022-12-02T20:26:08.3234204+01:00",
    "date_update": "2022-12-02T20:26:08.3234204+01:00",
    "date_closed": "2022-12-02T20:26:08.3234204+01:00",
    "suggested_user_id": "d3b143c2-fee7-4b37-ad36-9d5a015680f2",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "cc5f78f1-63a2-4c6a-8dc6-3f047ef43089",
      "db_language_id": "04572427-22b1-4f6a-9ed2-167646fc5f13",
      "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": "2022-12-02T20:26:08.3234204+01:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "6318ac1d-245e-47ca-9377-05a6f125864b",
      "sales_organization": {
        "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
        "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
        "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
        "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": "2022-12-02T20:26:08.3234204+01:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "31d005ff-7c37-4c6c-85d9-d8e76f6e28df",
      "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": "7f5a8dbf-a77c-497a-a59b-5e9e63eddeac",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "54a26581-b82f-4d30-b2a6-3bea16df0b0e"
    },
    "suggested_date_start": "2022-12-02T20:26:08.3234204+01:00",
    "skill_id": "a0b1d178-ce03-42ba-983f-9eab7374584b",
    "skill_code": "sample string 32",
    "skill": {
      "id": "49ef4ac8-9aa5-4c86-aec6-d8598766f25c",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "bc62e6fe-abf7-49ea-9db2-c5275ac5a0a8",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "ab06ba27-752e-48db-b0d5-116c1e7fa03a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1608877a-4d37-4e2b-acbc-dd2753be4c09",
        "db_currency_id": "7e703f6b-855e-461f-acc5-8f4d533fc4cb",
        "db_language_id": "ed6c2db6-8b17-4cec-a364-2f11b917370c",
        "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": "2022-12-02T20:26:08.3234204+01:00"
      },
      "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "2316c6e7-47e8-4835-beff-7a4cfb0ab0aa",
    "date_reported_by_company": "2022-12-02T20:26:08.3234204+01:00",
    "id2": 36,
    "company_id": "d56a7bbd-5747-4bca-a02b-fe7abec09be2",
    "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": "9ba521fb-b0ca-4297-8650-635b9336af4d",
    "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": "2022-12-02T20:26:08.3234204+01:00"
  },
  "work_instruction_details_id": "cb358e36-48cb-4f79-b918-39c091d0eefc",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "5f615b0c-a3b2-44f3-82b1-c5816f9bc7b7",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "c5d30960-6175-464e-89e3-716d1ae9e3fe",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2022-12-02T20:26:08.3234204+01: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": "ebd08c56-f016-40b4-bf89-6b8751d4bea3",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2022-12-02T20:26:08.3234204+01:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.