Skip to content
Download OpenAPI description
Languages
Servers
Mock server

https://docs.zimark.link/_mock/api/

https://api.zimark-staging.link/

https://api.zimark.link/

Operations
Operations
Operations

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/comments' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*Array [
createDatestring(date-time)
updateDatestring(date-time)
additionalInfostring

Additional information about the track

Example: "Track is in good condition"
authorobject(AuthorResponseV1Dto)

Author who created this metadata

attachmentsArray of objects(AttachmentV1Dto)

Attachments related to the track metadata

]

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
Bodyapplication/jsonrequired
additionalInfostring
attachmentsArray of objects(AttachmentV1Dto)
curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/comments' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "additionalInfo": "string",
    "attachments": [
      {
        "link": "string",
        "fileName": "string",
        "author": {
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phoneNumber": "string"
        },
        "description": "string"
      }
    ]
  }'

Responses

Ok

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/revert-retirement' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
Query
forceboolean
Default false
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/retire?force=false' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Request

Security
X-AUTH-KEY
Query
wmsIdstring
damagedTracksboolean
trackStatusstring
Enum"SCHEDULED_FOR_RETIREMENT""ACTIVE""NOT_ACTIVE""FLAGGED"
manifestExternalIdsArray of strings
qstring
createDateAfterinteger(int64)
createDateBeforeinteger(int64)
pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track?wmsId=string&damagedTracks=true&trackStatus=SCHEDULED_FOR_RETIREMENT&manifestExternalIds=string&q=string&createDateAfter=0&createDateBefore=0&pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
contentArray of objects(TrackV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
Query
pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/activity?pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
contentArray of objects(TrackActivityV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations