Infoworks Locked Entities API
The Locked Entities API from Infoworks — 7 operation(s) for locked entities.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/infoworks:infoworks-locked-entities-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
title: Infoworks Rest API V3 Locked Entities API
version: '1.0'
description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
variables:
protocol:
default: http
enum:
- http
- https
host:
default: localhost
port:
default: '3001'
tags:
- name: Locked Entities
paths:
/admin/locked-entities:
get:
security:
- BearerAuth: []
operationId: getLockedEntityList
summary: Get All Currently Locked Entities
description: Get All Currently Locked Entities.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
properties:
total_count:
type: integer
minimum: 0
example: 10
result:
items:
properties:
entity_state:
type: string
example: crawling
entity_type:
type: string
example: table_group
entity_name:
type: string
example: northwind_group
entity_id:
type: string
example: e77850ad5127a2d7dab870ff
job_id:
type: string
example: e77850ad5127a2d7dab870ff
job_type:
type: string
example: source_ingest
job_status:
type: string
example: blocked
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/admin/unlock-entities:
post:
security:
- BearerAuth: []
operationId: unlockEntities
summary: Unlock Currently Locked Entities
description: Unlocks all Currently Locked Entities.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- properties:
result:
items:
properties:
id:
type: string
example: e77850ad5127a2d7dab870ff
error:
type:
- string
- 'null'
example: Example Error
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/admin/locked-entities/{entity_id}:
parameters:
- name: entity_id
in: path
required: true
schema:
type: string
get:
security:
- BearerAuth: []
operationId: getLockedEntity
summary: Get a specific currently Locked Entity
description: Get a specific currently Locked Entity.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- properties:
result:
properties:
entity_state:
type: string
example: crawling
entity_type:
type: string
example: table_group
entity_name:
type: string
example: northwind_group
entity_id:
type: string
example: e77850ad5127a2d7dab870ff
job_id:
type: string
example: e77850ad5127a2d7dab870ff
job_type:
type: string
example: source_ingest
job_status:
type: string
example: blocked
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/admin/unlock-entities/{entity_id}:
parameters:
- name: entity_id
in: path
required: true
schema:
type: string
post:
security:
- BearerAuth: []
operationId: unlockEntity
summary: Unlock a Currently Locked Entity
description: Unlock a Currently Locked Entity.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- type: object
properties:
result:
type: string
example: e77850ad5127a2d7dab870ff
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/prodops/locked-entities/{locked_entity_id}:
parameters:
- name: locked_entity_id
in: path
required: true
schema:
type: string
get:
security:
- BearerAuth: []
operationId: getLockedEntityForProdOps
summary: Get a specific currently Locked Entity
description: Get a specific currently Locked Entity for Prodops user.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- properties:
result:
properties:
entity_state:
type: string
example: crawling
entity_type:
type: string
example: table_group
entity_name:
type: string
example: northwind_group
entity_id:
type: string
example: e77850ad5127a2d7dab870ff
job_id:
type: string
example: e77850ad5127a2d7dab870ff
job_type:
type: string
example: source_ingest
job_status:
type: string
example: blocked
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/prodops/locked-entities:
get:
security:
- BearerAuth: []
operationId: getLockedEntitiesForProdOps
summary: Get All Currently Locked Entities
description: Get All Currently Locked Entities.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
properties:
total_count:
type: integer
minimum: 0
example: 10
result:
items:
properties:
entity_state:
type: string
example: crawling
entity_type:
type: string
example: table_group
entity_name:
type: string
example: northwind_group
entity_id:
type: string
example: e77850ad5127a2d7dab870ff
job_id:
type: string
example: e77850ad5127a2d7dab870ff
job_type:
type: string
example: source_ingest
job_status:
type: string
example: blocked
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
/prodops/unlock-entities:
post:
security:
- BearerAuth: []
operationId: unlockEntitiesForProdOps
summary: Unlock Currently Locked Entities
description: Unlocks all Currently Locked Entities.
tags:
- Locked Entities
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
example: Example Success Message
- properties:
result:
items:
properties:
id:
type: string
example: e77850ad5127a2d7dab870ff
error:
type:
- string
- 'null'
example: Example Error
'400':
description: Request has invalid body or parameters.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10006
help:
type: string
example: http://api.infoworks.io/help/IW10006
'401':
description: Authentication Failed. Please check your Credentials
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10005
help:
type: string
example: http://api.infoworks.io/help/IW10005
'403':
description: Forbidden. User lacks access to specified resource.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10004
help:
type: string
example: http://api.infoworks.io/help/IW10004
'500':
description: Internal Server Error.
content:
application/json:
schema:
type: object
allOf:
- type: object
properties:
message:
type: string
example: Something went wrong
details:
type: object
properties: {}
- type: object
properties:
iw_code:
type: string
example: IW10002
help:
type: string
example: http://api.infoworks.io/help/IW10002
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
BasicAuth:
type: http
scheme: basic