External ID Service (0.6.39)

Download OpenAPI specification:Download

Endpoint for mapping internal and external IDs in the context denoted by an organization ID and an application ID.

Namespace

Operations on getting and adding namespaces. Namespaces scope external IDs not just to an organization, but also to a namespace.

Get existing namespaces

Returns all namespaces for the organization

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

existing namespaces

401

Not authorized

get/org/{org-id}/namespaces

Production

https://external.apis.enfore.com/external/org/{org-id}/namespaces

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
["string"
]
}

Check existence

Test if the namespace exists

path Parameters

org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Responses

200

401

Not authorized

404

namespace not found

get/org/{org-id}/namespaces/{namespace}

Production

https://external.apis.enfore.com/external/org/{org-id}/namespaces/{namespace}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Create namespace

creates a new namespace

path Parameters

org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Responses

200

401

Not authorized

409

namespace already exists

post/org/{org-id}/namespaces/{namespace}

Production

https://external.apis.enfore.com/external/org/{org-id}/namespaces/{namespace}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Batch by ID tuples

Generic set of operations on mappings.

Returns all mappings for entity class.

Returns all external internal ID mappings for the given entity class

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Responses

200

All mappings for the entity class

401

Not authorized

get/org/{org-id}/{namespace}/mappings/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/{entity-class}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
]
}

Replaces all mappings.

Existing mappings are deleted and replaced with the payload

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Request Body schema: application/json

items

required

Array of objects (Mapping)

The mapping of internal to external ID

Responses

200

401

Not authorized

409

Payload contains illegal mappings

put/org/{org-id}/{namespace}/mappings/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/{entity-class}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
]
}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Adds new mappings.

Adds provided mappings.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Request Body schema: application/json

items

required

Array of objects (Mapping)

The mapping of internal to external ID

Responses

200

401

Not authorized

409

Mappings contain a collision

post/org/{org-id}/{namespace}/mappings/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/{entity-class}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
]
}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Batch by external IDs

Set of operations on mappings by external IDs. The external IDs need to match/are leading.

Mappings for given external IDs

Returns all external internal ID mappings for the provided external IDs.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

query Parameters

externalIds

required

Array of strings non-empty

Responses

200

all mappings and potential problems

401

Not authorized

get/org/{org-id}/{namespace}/mappings/external/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/external/{entity-class}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
],
"not_found": 
["string"
]
}

Replace the internal IDs.

Replaces existing mappings with a new internal ID.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Request Body schema: application/json

items

required

Array of objects (Mapping)

The mapping of internal to external ID

Responses

200

401

Not authorized

409

Mappings contain a collision

put/org/{org-id}/{namespace}/mappings/external/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/external/{entity-class}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
]
}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

By external ID

Operations on a mapping by external ID. The external ID needs to match/is leading.

Get internal ID.

Get internal ID by provided external.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.
external-id required	string External ID.

Responses

200

single mapping.

401

Not authorized

404

Not found

get/org/{org-id}/{namespace}/mappings/external/{entity-class}/{external-id}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/external/{entity-class}/{external-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"internal_id": "string",
"external_id": "string"
}

Deletes mapping.

Deletes mapping by external ID.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.
external-id required	string External ID.

Responses

200

401

Not authorized

404

Not found

delete/org/{org-id}/{namespace}/mappings/external/{entity-class}/{external-id}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/external/{entity-class}/{external-id}

Batch by internal IDs

Set of operations on mappings by internal IDs. The internal IDs need to match/are leading.

Mappings for given internal IDs.

Returns all internal external ID mappings for the provided internal IDs.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

query Parameters

internalIds

required

Array of strings non-empty

Responses

200

all mappings and potential problems

401

Not authorized

get/org/{org-id}/{namespace}/mappings/internal/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/internal/{entity-class}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
],
"not_found": 
["string"
]
}

Replace the external IDs.

Replaces existing mappings with a new external ID.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.

Request Body schema: application/json

items

required

Array of objects (Mapping)

The mapping of internal to external ID

Responses

200

401

Not authorized

409

Mappings contain a collision

put/org/{org-id}/{namespace}/mappings/internal/{entity-class}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/internal/{entity-class}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"internal_id": "string",
"external_id": "string"
}
]
}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

By internal ID

Operations on a mapping by internal ID. The internal ID needs to match/is leading.

Get external ID.

Get external ID by provided internal

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.
internal-id required	string Internal ID.

Responses

200

single mapping

401

Not authorized

404

Not found

409

Conflict

get/org/{org-id}/{namespace}/mappings/internal/{entity-class}/{internal-id}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/internal/{entity-class}/{internal-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"internal_id": "string",
"external_id": "string"
}

Deletes mapping.

Deletes mapping by internal ID.

path Parameters

entity-class required	string Entity class scope.
org-id required	string ID of the organization whose data is being accessed.
namespace required	string The namespace for the ID mapping.
internal-id required	string Internal ID.

Responses

200

401

Not authorized

404

Not found

delete/org/{org-id}/{namespace}/mappings/internal/{entity-class}/{internal-id}

Production

https://external.apis.enfore.com/external/org/{org-id}/{namespace}/mappings/internal/{entity-class}/{internal-id}

External ID Service (0.6.39)

Meta

Get all entity classes

path Parameters

Responses

Response samples

Namespace

Get existing namespaces

path Parameters

Responses

Response samples

Check existence

path Parameters

Responses

Response samples

Create namespace

path Parameters

Responses

Response samples

Batch by ID tuples

Returns all mappings for entity class.

path Parameters

Responses

Response samples

Replaces all mappings.

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Adds new mappings.

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Batch by external IDs

Mappings for given external IDs

path Parameters

query Parameters

Responses

Response samples

Replace the internal IDs.

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

By external ID

Get internal ID.

path Parameters

Responses

Response samples

Deletes mapping.

path Parameters

Responses

Batch by internal IDs

Mappings for given internal IDs.

path Parameters

query Parameters

Responses

Response samples

Replace the external IDs.

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

By internal ID

Get external ID.

path Parameters

Responses

Response samples

Deletes mapping.

path Parameters

Responses