List Mappings

List all mappings in a given project. If more than limit mappings exist, a cursor for pagination will be returned with the response.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
Responses
200

List of mappings and an optional cursor.

400

The response for a bad request.

422

Validation Error

get/hostedextractors/mappings
Request samples 
mapping_list = client.hosted_extractors.mappings.list(limit=5)

for mapping in client.hosted_extractors.mappings:
    mapping # do something with the mapping

for mapping_list in client.hosted_extractors.mappings(chunk_size=25):
    mapping_list # do something with the mappings
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to Retrieve Mappings