1.4 Lists of API functions

The following lists describe the API functions available in Ops I.

• List of standard API functions
• List of custom API functions

For details on API functions, see “Detailed API reference information”.

(Table) List of standard API functions

Category	Method	URL	Function
users	GET	/api/v1/users	The API obtains a list of users.
	GET	/api/v1/users/{id}	The API obtains detailed information about the user with the specified ID.
groups	GET	/api/v1/groups	The API obtains a list of groups.
	GET	/api/v1/groups/{id}	The API obtains detailed information about a group.
schedules	GET	/api/v1/schedules/{id}	The API obtains schedule information.
	PUT	/api/v1/schedules/{id}	The API updates schedule information. (This is used to update My Workflow agents and the like.)
documents	GET	/api/v1/documents	The API obtains a list of YAML files. (Information is retrieved from the uploaded YAML file)
	GET	/api/v1/documents/{id}	The API obtains detailed information about a YAML file.
	GET	/api/v1/documents/{id}/files	The API obtains files in the repository where the YAML file is located. (This is used to download the client script (JavaScript) files defined in the Script YAML file)
graphql	POST	/api/v1/graphql	The API executes a GraphQL query. (Data retrieval, insertion, update, and deletion are all performed by submitting a query and are therefore POST only.) Note Take care when using this function, as it ignores validation in the app and UI and acts directly on the database.
repositories	POST	/api/v1/repositories	The API creates a repository in GitLab. Do not create the repository on the GitLab screen, as the necessary Webhook settings, etc., will be performed. Creating the repository also updates system-configs to apply the information contained in uploaded YAML files.
	GET	/api/v1/repositories	The API obtains a list of repositories.
	DELETE	/api/v1/repositories/{id}	The API deletes a repository.
practice-contexts	GET	/api/v1/practice-contexts	The API obtains a list of practice-contexts. (This is mainly used to retrieve the ContextID needed for subsequent processing in client scripts.)
	GET	/api/v1/practice-contexts/{id}	The API obtains detailed My Workflow information.
	DELETE	/api/v1/practice-contexts /{id}	The API deletes My Workflow and its sub-flows.
acls	GET	/api/v1/acls	The API obtains a list of ACLs.
	GET	/api/v1/acls/{name}	The API obtains detailed ACL information.
	GET	/api/v1/acls/roles/{roleName}	The API obtains ACLs assigned to a role.
	POST	/api/v1/acls/roles/{roleName}	The API assigns ACLs to roles.
	DELETE	/api/v1/acls/roles/{roleName}	The API removes ACLs assigned to a role.
Customer Users	GET	/api/v1/customer-users	The API obtains a list of customer users.
gitops-logs	GET	/api/v1/gitops-logs	The API obtains the validation results of the uploaded YAML file.
container-items	GET	/api/v1/container-items	The API obtains a list of documents.
	POST	/api/v1/container-items/{id}/files	The API uploads a file to the document repository.
files	GET	/api/v1/files/{group}/{repository}/{path}	The API obtains detailed information of a file.
	GET	/api/v1/files/{group}/{repository}/{path}/raw	The API obtains a file.
service-catalogs	GET	/api/v1/service-catalogs	The API obtains a list of service catalogs.
workflows	POST	/api/v1/workflows/{id}/execute	The API starts a workflow.
Refresh Token	POST	/oauth2/refresh-token	The API uses the Ops I token to obtain the Ops I access token. (The API retrieves the Ops I access token that is actually granted to the REST API call. For details, see "Obtaining Ops I access tokens (not recommended)".)

(Table) List of custom API functions