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": "59252760-5312-46ed-9af7-e6921452bbe5",
  "jobs_id": "4ccb3232-b941-4588-adf7-495b2a236850",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "d8dd14be-60fd-4cc3-94d7-bd31fe3196f9",
    "_parent_id": "0a4d3b5f-6f03-4f98-903a-bc25cb219373",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "4a80dc60-b035-4ebd-b781-668a3d81c4f0",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "48b39059-d5e7-478e-b5a0-fbcd8dd05988",
      "_parent_id": "015e8ead-8f3f-44be-ae4d-226629a944c7",
      "root_parent_id": "89209cc4-770a-44ba-8488-3f02463a31b4",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "a0c0ed9f-be64-484a-b02d-6021272eca5e",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "caa2eb12-1c7e-4ce0-a466-6608553816e6",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "7818a8f4-5e52-461d-b381-65d13bac484c",
        "_parent_code": "sample string 6",
        "sales_organization_id": "4023eabb-9417-4ef9-9b86-81bec4319b88",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
          "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
          "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
          "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-03-01T01:20:35.2420522+00:00"
        },
        "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
      },
      "equipment_model_id": "1fdafcc0-945e-4194-b5d0-e04ce2f6be4e",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "569751cb-aae4-4d6c-88bc-eb2f2e785fef",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "9f28ed10-292f-4279-8f47-6906d7710bcb",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "f7b404d1-041c-4b93-8bcf-0a8555764551",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "f6e8fe6e-e6dc-4ad1-8d8c-54a3b29c9c1b",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
            "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
            "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
            "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-03-01T01:20:35.2420522+00:00"
          },
          "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
        },
        "equipment_family_id": "ff18b3ab-3450-47fe-a05b-c943296a1530",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "caa2eb12-1c7e-4ce0-a466-6608553816e6",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "7818a8f4-5e52-461d-b381-65d13bac484c",
          "_parent_code": "sample string 6",
          "sales_organization_id": "4023eabb-9417-4ef9-9b86-81bec4319b88",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
            "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
            "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
            "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-03-01T01:20:35.2420522+00:00"
          },
          "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
        },
        "date_in_production_since": "2024-03-01T01:20:35.2420522+00:00",
        "date_out_of_production_since": "2024-03-01T01:20:35.2420522+00:00",
        "date_end_support": "2024-03-01T01:20:35.2420522+00:00",
        "sales_organization_id": "f6ac87f3-4100-4b6f-81d2-802293ad1060",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
          "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
          "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
          "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-03-01T01:20:35.2420522+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-03-01T01:20:35.2420522+00:00"
      },
      "project_status_id": "3334dcef-379e-4505-9f01-b02a981473e8",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "31bbaca8-164e-4929-86d1-4ba38474b09a",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "5575b81e-ee4e-4197-a661-d83675d7291b",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
          "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
          "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
          "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-03-01T01:20:35.2420522+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
      },
      "company_id": "086c5e0b-ad02-41db-a024-a74002b89e03",
      "company_code": "sample string 12",
      "db_address_id": "62f14191-3767-4cc0-ba6a-c54e317817bc",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "20cb8fef-d13e-471c-8cf6-e8dc5ff80860",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "6b2a1f22-af55-4425-9f54-19ca0a59fe24",
      "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-03-01T01:20:35.2420522+00:00",
      "date_create": "2024-03-01T01:20:35.2420522+00:00",
      "date_update": "2024-03-01T01:20:35.2420522+00:00",
      "updated_by_user_id": "6f4781cf-890e-4eb0-bc4d-e7dce1a15969",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2024-03-01T01:20:35.2420522+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-03-01T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2024-03-01T01:20:35.2420522+00:00",
      "date_last_job": "2024-03-01T01:20:35.2420522+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2024-03-01T01:20:35.2420522+00:00",
      "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "c5869adf-3822-4228-bb24-9fb7db4907d6",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "c617baf6-68be-4f0d-9f4a-a00005d9f815",
      "name": "sample string 2",
      "sales_organization_id": "4b17785d-8158-4155-81ea-028e63c8db72",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "30d4892c-3828-4851-a374-b6cacca755ba",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "958f8620-25d5-4389-9cc8-46e3d56440b5",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "a41a913d-26bd-4519-8fe8-3f8837aae056",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
        "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
        "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
        "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-03-01T01:20:35.2420522+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
    },
    "job_status_id": "05535ce3-592c-47f6-aa06-60071b6610af",
    "job_status_code": "sample string 11",
    "db_address_id": "0fc875e6-6fae-4b47-ae9a-9d0b69a2888b",
    "contact_id": "a867db0c-7b3f-492b-ac4f-efb3c53b585b",
    "requested_by_company_id": "56ed0ba0-79a6-489d-b03f-e7f2b8003696",
    "requested_by_contact_id": "d118e360-3684-4bd7-a376-75029a8187be",
    "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-03-01T01:20:35.2420522+00:00",
    "due_date": "2024-03-01T01:20:35.2420522+00:00",
    "date_create": "2024-03-01T01:20:35.2420522+00:00",
    "date_update": "2024-03-01T01:20:35.2420522+00:00",
    "date_closed": "2024-03-01T01:20:35.2420522+00:00",
    "suggested_user_id": "8697aa13-fbf1-47b7-8a47-d1591527f8a7",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "d79b65c9-a0f2-427f-83d2-5678e02c1078",
      "db_language_id": "98c2975f-df1a-43d5-8361-2a9c4659d1dd",
      "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-03-01T01:20:35.2420522+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "1858e489-cb2a-4fab-9009-035cc0bf268f",
      "sales_organization": {
        "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
        "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
        "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
        "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-03-01T01:20:35.2420522+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "4592c08f-4758-4c4f-af64-1eb42d44d88d",
      "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": "0906c6f3-08ab-4705-8a26-bce19c44a328",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "5109cd87-05e0-4f91-93ca-38039be40ba2"
    },
    "suggested_date_start": "2024-03-01T01:20:35.2420522+00:00",
    "skill_id": "3592c999-0024-4537-8291-b386125b1505",
    "skill_code": "sample string 32",
    "skill": {
      "id": "9cc239d3-bb88-40a5-96c1-5bf93afa26a1",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "5a0d844e-b3e4-4bac-827a-efe2a619786a",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "3a59b3fc-c30c-4bc2-a8cf-44af4daf79a1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "efeea83d-2753-4de0-bbc7-df774aa379f4",
        "db_currency_id": "7be4aebd-a036-4158-adaa-b5b1d4dcb31d",
        "db_language_id": "0747a413-af8f-4f1f-b136-d1e04c074c3b",
        "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-03-01T01:20:35.2420522+00:00"
      },
      "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "317e6f83-fce4-485d-81a0-21f6c2e1c69d",
    "date_reported_by_company": "2024-03-01T01:20:35.2420522+00:00",
    "id2": 36,
    "company_id": "8dab0c22-b152-4432-9720-e07fabdcd7e5",
    "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": "d10c2b02-8c3a-4151-b621-f7634afcdf3b",
    "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-03-01T01:20:35.2420522+00:00"
  },
  "work_instruction_details_id": "922024dc-745d-4409-8483-485dd739dc25",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "5ae87db0-9e4a-4454-846b-cd010070ee02",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "1e542fad-5adc-4b62-be16-320a219d4f23",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2024-03-01T01:20:35.2420522+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": "34f15f4e-cea1-4292-8191-9941e29d6ce3",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2024-03-01T01:20:35.2420522+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.