AssignmentService Resource

A set of services related to assignments.

GET /v1/assignment/list

Lists all available assignments with the option on listing on a specific AssignmentType only. The assignments are ordered by id in ascending order.
If no type is specificed, any signal_reader assignments are ordered first, then idc and last area5 assignments.

Request Parameters
name type description default constraints
auth-token header The authentication token.    
limit query Limit the number of results returned by this query. 25 int
offset query Use offset to fetch the next assignments if the total number of assignments exceeds the limit used. See AssignmentResult. 0 int
type query The AssignmentType of interest.   "arcos" or "area5" or "audio" or "blue_pirat" or "canrecorder" or "dlt" or "etas" or "ethernet_capture" or "file_fetcher" or "idc" or "ipemotionrt" or "lpd" or "mcdhub" or "mlog" or "mqtt" or "rp" or "shub" or "signal_reader" or "smart_eye" or "soh" or "swdl" or "video"
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
400 If the provided type is not supported. The supported types are currently signal_reader, idc and area5.
Response Body
media type data type description
application/json AssignmentResult (JSON) All available assignments.

Example

Request
GET /list?type=signal_reader
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : {
    "id" : 12345,
    "name" : "...",
    "type" : "swdl"
  },
  "count" : 10,
  "offset" : 0,
  "limit" : 25
}

GET /v1/assignment/area5/{id}

Get more information of a specific area5 assignment.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path The id of the assignment. required long
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
400 If the provided id does not match a area5 assignment.
403 If the requesting user is not allowed to view area5 assignments.
Response Body
media type data type description
application/json Area5AssignmentInfo (JSON)

Example

Request
GET /area5/123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "type" : "area5",
  "id" : 12345,
  "name" : "Assignment test 1",
  "ownerLoginID" : "anders.svensson",
  "vehicleProfileVersion" : {
    "version-id" : 12345,
    "name" : "Vehicle profile 1"
  },
  "usingLatestVehicleProfile" : true,
  "creationDate" : "2024-04-01T12:52:32Z",
  "" : "2024-04-02T12:52:32Z",
  "comment" : "...",
  "accessRights" : "PUBLIC",
  "canEdit" : true
}

GET /v1/assignment/idc/{id}

Get more information of a specific idc assiugnment.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path The id of the assignment. required long
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
400 If the provided id does not match a idc assignment.
403 If the requesting user is not allowed to view signal reader assignments.
Response Body
media type data type description
application/json IDCAssignmentInfo (JSON)

Example

Request
GET /idc/123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "type" : "idc",
  "id" : 12345,
  "name" : "Assignment test 1",
  "ownerLoginID" : "anders.svensson",
  "vehicleProfileVersion" : {
    "version-id" : 12345,
    "name" : "Vehicle profile 1"
  },
  "usingLatestVehicleProfile" : true,
  "creationDate" : "2024-04-01T12:52:32Z",
  "" : "2024-04-02T12:52:32Z",
  "comment" : "...",
  "accessRights" : "PUBLIC",
  "canEdit" : true
}

GET /v1/assignment/sequence_file/{id}

Download the sequence file for the provided sequence file id. See DREC.

Request Parameters
name type description
auth-token header The authentication token.
id path
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
400 If the provided id does not match a sequence file.
Response Body
media type data type description
application/octet-stream object

Example

Request
GET /v1/assignment/sequence_file/{id}
Content-Type: */*
Accept: application/octet-stream
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/octet-stream

                
...

GET /v1/assignment/signal_reader/{id}

Get more information of a specific signal reader assignment.

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path Optional. The id of the assignment. See AssignmentIdentifier. required long
Response Codes
code condition
401 If no or an invalid authentication token is supplied.
400 If the provided id does not match a signal reader assignment.
403 If the requesting user is not allowed to view signal reader assignments.
Response Body
media type data type description
application/json SignalReaderAssignmentInfo (JSON)

Example

Request
GET /signal_reader/123
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "type" : "signal_reader",
  "id" : 12345,
  "name" : "Assignment test 1",
  "ownerLoginID" : "anders.svensson",
  "vehicleProfileVersion" : {
    "version-id" : 12345,
    "name" : "Vehicle profile 1"
  },
  "usingLatestVehicleProfile" : true,
  "creationDate" : "2024-04-01T12:52:32Z",
  "" : "2024-04-02T12:52:32Z",
  "comment" : "...",
  "accessRights" : "PUBLIC",
  "canEdit" : true
}

POST /v1/assignment/signal_reader/copy/{id}

Make a copy of the provided Signal reader assignment identified by the provided id.
If the vehicle profile the assignment is based on has been updated since the provided assignment was created,
a 400 Bad Request is returned.
In this case, the assignment can be converted to the updated vehicle profile by setting the query parameter convert to true.

Some assignments are based on vehicle profiles which have EcuToDescriptionFileAssociations. If these are not supplied when copying an assignment signals from the associated signal sources will not be selectable in the copied assignment. To check beforehand what associations might be needed for an assignment, use GET AssignmentService

Request Parameters
name type description constraints
auth-token header The authentication token.  
id path The assignment to copy. required long
convert query true if the assignment should be converted if the vehicle profile the assignment is based on has changed. false to not convert and therefore also abort the copy process. boolean
Request Body
media type data type description
application/json array of EcuToDescriptionFileAssociation (JSON) Any referenced ECU to description file associations.
Response Codes
code condition type
200 The assignment was successfully copied.
202 The assignment copy process takes some time to finish but the result will be available at the returned link.
400 The provided id does not match a signal reader assignment.
    400 The vehicle profile has changed and 'convert' is not provided or set to false.
      404 The vehicle profile the assignment is based on has been deleted.
        401 If no or an invalid authentication token is supplied.
          Response Body
          media type data type description
          application/json object (JSON) The copy of the assignment.

          Example

          Request
          POST /v1/assignment/signal_reader/copy/{id}
Content-Type: application/json
Accept: application/json
auth-token: ...

                
[ {
  "ecu-name" : "CEM",
  "type" : "A2L",
  "association-id" : 123
} ]
          Response
          HTTP/1.1 200 OK
Content-Type: application/json

                
...

          GET /v1/assignment/signal_reader/{id}/drec

          Returns any DRECs for the provided signal reader assignment id. Associated sequence files can be downloaded via GET AssignmentService.

          Request Parameters
          name type description constraints
          auth-token header The authentication token.  
          id path The signal reader assignment id. required long
          Response Codes
          code condition
          401 If no or an invalid authentication token is supplied.
          400 If the provided id does not match a signal reader assignment.
          403 If the requesting user is not allowed to view signal reader assignments.
          Response Body
          media type data type description
          application/json array of DREC (JSON)

          Example

          Request
          GET /v1/assignment/signal_reader/{id}/drec
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
          Response
          HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "sequence-file-id" : "seq123456.seq",
  "name" : "DREC_1",
  "read-extended-data" : true,
  "read-snapshot" : true,
  "repeat" : true
} ]

          GET /v1/assignment/signal_reader/copy/result/{uuid}

          Get the copied assignment in case POST AssignmentService returned a 202.

          Request Parameters
          name type description
          auth-token header The authentication token.
          uuid path
          Response Codes
          code condition type
          200 The assignment was successfully copied.
          202 The assignment copy process is not ready yet
          400 The provided uuid is not valid or does not match any copy signal reader assignment process
            403 The user has not permission to copy the selected assignment.
              412 The assignment could not be copied because all preconditions are not fulfilled.
                401 If no or an invalid authentication token is supplied.
                  Response Body
                  media type data type description
                  application/json object (JSON)

                  Example

                  Request
                  GET /v1/assignment/signal_reader/copy/result/{uuid}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
                  Response
                  HTTP/1.1 200 OK
Content-Type: application/json

                
...

                  GET /v1/assignment/signal_reader/copy/{id}/referenced-associations

                  Check if the vehicle profile the provided assignment is based on has any EcuToDescriptionFileAssociation referenced.

                  Request Parameters
                  name type description constraints
                  auth-token header The authentication token.  
                  id path The assignment id of interest. required long
                  Response Codes
                  code condition
                  401 If no or an invalid authentication token is supplied.
                  Response Body
                  media type data type description
                  application/json ReferencedECUAssociations (JSON)

                  Example

                  Request
                  GET /v1/assignment/signal_reader/copy/{id}/referenced-associations
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
                  Response
                  HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "referenced-associations" : [ {
    "ecu-name" : "CEM",
    "type" : "A2L",
    "association-id" : 123
  }, {
    "ecu-name" : "...",
    "type" : "A2L",
    "association-id" : 12345
  } ],
  "vehicle-profile-id" : 12345,
  "assignment-id" : 12345
}

                  GET /v1/assignment/signal_reader/{id}/signals/srec

                  Returns all SREC signals for the provided signal reader assignment id.

                  Request Parameters
                  name type description constraints
                  auth-token header The authentication token.  
                  id path The signal reader assignment id. required long
                  Response Codes
                  code condition
                  401 If no or an invalid authentication token is supplied.
                  400 If the provided id does not match a signal reader assignment.
                  403 If the requesting user is not allowed to view signal reader assignments.
                  Response Body
                  media type data type description
                  application/json array of SRECSignal (JSON)

                  Example

                  Request
                  GET /v1/assignment/signal_reader/{id}/signals/srec
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
                  Response
                  HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "type" : "SREC",
  "name" : "...",
  "moduleInfo" : {
    "moduleType" : "INTERNAL_OBD2",
    "moduleName" : "..."
  }
} ]