Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All URIs are relative to http://<your_SC_server_FQDN>

Class

Method

HTTP request

Description

ArtifactApi

create_artifact

POST /artifacts

Create a new artifact

ArtifactApi

delete_artifacts_by_key

DELETE /artifacts/{key}

Delete an artifact given the artifact key

ArtifactApi

get_artifact_by_external_id

POST /artifacts/external/id

Get an artifact given the artifact external id

ArtifactApi

get_artifact_by_key

GET /artifacts/{key}

Get an artifact given the artifact key

ArtifactApi

get_artifact_by_key_and_version

GET /artifacts/{key}/versions/{version}

Get an artifact given the artifact key and version

ArtifactApi

get_artifact_versions_by_key

GET /artifacts/{key}/versions

Get all versions of an artifact given the artifact key

ArtifactApi

get_artifacts

GET /artifacts

Get all artifacts

ArtifactApi

update_artifact_by_key

PUT /artifacts/{key}

Update artifact given the artifact key

ArtifactTypeApi

create_artifact_type

POST /types/artifact

Create a new Artifact type

ArtifactTypeApi

delete_artifact_type_by_key

DELETE /types/artifact/{key}

Delete an Artifact type given the Artifact type key

ArtifactTypeApi

get_artifact_type_by_external_id

POST /types/artifact/external/id

Get an artifact type given the artifact type external id

ArtifactTypeApi

get_artifact_type_by_key

GET /types/artifact/{key}

Get an Artifact type given the Artifact type key

ArtifactTypeApi

get_artifact_type_by_key_and_attribute_definition_id

GET /types/artifact/{key}/attribdefs/{id}

Get an attribute definition of an artifact type given the artifact type key and attribute definition id

ArtifactTypeApi

get_artifact_types

GET /types/artifact

Get all artifact types

ArtifactTypeApi

update_artifact_type_by_key

PUT /types/artifact/{key}

Update an Artifact type given the Artifact key

AuthApi

create_super_user

GET /signUp/superuser

Sign-up super user

AuthApi

create_user

POST /signUp

Create a new user (sign-up)

AuthApi

diable_internal_user

POST /account/disable

Disable internal user

AuthApi

enable_internal_user

POST /account/enable

Enable internal user

AuthApi

get_new_password

POST /password/reset

Reset user password

AuthApi

get_token

POST /signIn

Sign-in a user

AuthApi

get_token_by_provider

POST /authenticate/{provider}

Authenticate user through Auth Provider e.g LDAP

AuthApi

sign_out_user

GET /signOut

Sign-out a user

AuthApi

update_password

POST /password/change

Change user password

ContainerApi

create_container

POST /containers

Create a new container

ContainerApi

delete_container_by_key

DELETE /containers/{key}

Delete a container given the container key

ContainerApi

get_container_by_external_id

POST /containers/external/id

Get a container given the container external id

ContainerApi

get_container_by_key

GET /containers/{key}

Get a container given the container key

ContainerApi

get_containers

GET /containers

Get all containers

ContainerApi

update_container_by_key

PUT /containers/{key}

Update a container given the container key

ContainerTypeApi

create_container_type

POST /types/container

Create a new Container type

ContainerTypeApi

delete_container_type_by_key

DELETE /types/container/{key}

Delete a Container type given the container type key

ContainerTypeApi

get_container_type_by_external_id

POST /types/container/external/id

Get a container type given the container type external id

ContainerTypeApi

get_container_type_by_key

GET /types/container/{key}

Get a Container type given the Container type key

ContainerTypeApi

get_container_type_by_key_and_attribute_definition_id

GET /types/container/{key}/attribdefs/{id}

Get a attribute definition of container type given the container type key and attribute definition id

ContainerTypeApi

get_container_types

GET /types/container

Get all container types

ContainerTypeApi

update_container_type_by_key

PUT /types/container/{key}

Update a Container type given the Container key

GraphApi

get_raw_graph_result

POST /graph/query/raw

Get result of a graph query

RelationApi

create_relation

POST /relations

Create a new relation

RelationApi

delete_relations_by_key

DELETE /relations/{key}

Delete a relation given the relation key

RelationApi

get_relation_by_external_id

POST /relations/external/id

Get a relation given the relation external id

RelationApi

get_relation_by_key

GET /relations/{key}

Get a relation given the relation key

RelationApi

get_relation_by_key_and_version

GET /relations/{key}/versions/{version}

Get a relation given the relation key and version

RelationApi

get_relation_versions_by_key

GET /relations/{key}/versions

Get all versions of a relation given the relation key

RelationApi

get_relations

GET /relations

Get all relations

RelationApi

update_relation_by_key

PUT /relations/{key}

Update relation given the relation key

RelationTypeApi

create_relation_type

POST /types/relation

Create a new Relation type

RelationTypeApi

delete_relation_type_by_key

DELETE /types/relation/{key}

Delete a Relation type given the Relation type key

RelationTypeApi

get_relation_type_by_external_id

POST /types/relation/external/id

Get a relation type given the relation type external id

RelationTypeApi

get_relation_type_by_key

GET /types/relation/{key}

Get a Relation type given the Relation type key

RelationTypeApi

get_relation_type_by_key_and_attribute_definition_id

GET /types/relation/{key}/attribdefs/{id}

Get an attribute definition of relation type given the relation type key and attribute definition id

RelationTypeApi

get_relation_types

GET /types/relation

Get all relation types

RelationTypeApi

update_relation_type_by_key

PUT /types/relation/{key}

Update a Relation type given the Relation key

RepositoryApi

create_repository

POST /repositories

Create a new repository

RepositoryApi

delete_repository_by_key

DELETE /repositories/{key}

Delete a repository given the repository key

RepositoryApi

get_repositories

GET /repositories

Get all repositories

RepositoryApi

get_repository_by_external_id

POST /repositories/external/id

Get a repository given the repository external id

RepositoryApi

get_repository_by_key

GET /repositories/{key}

Get a repository given the repository key

RepositoryApi

update_repository_by_key

PUT /repositories/{key}

Update a repository given the repository key

RepositoryTypeApi

create_repository_type

POST /types/repository

Create a new repository type

RepositoryTypeApi

delete_repository_type_by_key

DELETE /types/repository/{key}

Delete a repository type given the repository type key

RepositoryTypeApi

get_repository_type_by_external_id

POST /types/repository/external/id

Get a repository type given the repository type external id

RepositoryTypeApi

get_repository_type_by_key

GET /types/repository/{key}

Get a repository type given the repository type key

RepositoryTypeApi

get_repository_type_by_key_and_attribute_definition_id

GET /types/repository/{key}/attribdefs/{id}

Get a attribute definition of repository type given the repository type key and attribute definition id

RepositoryTypeApi

get_repository_types

GET /types/repository

Get all repository types

RepositoryTypeApi

update_repository_type_by_key

PUT /types/repository/{key}

Update a repository type given the repository key

UserApi

delete_user_by_key

DELETE /users/{key}

Delete a user given the user key

UserApi

get_user_by_key

GET /users/{key}

Get a user given the user key

UserApi

get_user_by_username

GET /users/username/{username}

Get a user given the user name

UserApi

get_users

GET /users

Get all users

UserApi

update_user_by_key

PUT /users/{key}

Update a user given the user key

Documentation For Models

Authors

  • Intercax DevTeam,

  • OpenAPI

...