1.4 Lists of API functions

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

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

(Table) List of Standard API functions (v1)

Category	Method	URL	Function
users	GET	/api/v1/users	The API obtains a list of users.
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.
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.
schedules	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 contexts. (This is mainly used to retrieve the Context ID needed for subsequent processing in client scripts.)
	DELETE	/api/v1/practice-contexts	The API deletes multiple workflows.
	GET	/api/v1/practice-contexts/{id}	The API obtains detailed My Workflow information.
	PATCH	/api/v1/practice-contexts/{id}	The API updates workflow details.
	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.
container-items	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.
files	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.
knowledge-articles	GET	/api/v1/knowledge-articles/{id}/attachments/{attachmentID}/download	The API downloads attachments from a knowledge article.
import-jobs	GET	/api/v1/import-jobs	The API obtains a list of import job execution results.
	POST	/api/v1/import-jobs	The API uploads a CSV file and starts an import job.
	GET	/api/v1/import-jobs/{id}	The API retrieves details of import job execution results.
	DELETE	/api/v1/import-jobs/{id}	The API deletes import job execution results.
	GET	/api/v1/import-jobs/{id}/errors	The API downloads rows where errors occurred in import job execution results as a CSV file.

(Table) List of Standard API functions (v2)

Category	Method	URL	Function
users	GET	api/v2/users/{id}	The API retrieves details for a user with the specified ID.
	PUT	api/v2/users/{id}	The API updates information for the user with the specified ID.
	GET	api/v2/users/{id}/groups	The API obtains groups assigned to the specified user.
	GET	api/v2/users/{id}/roles	effective=false or not specified: Retrieves roles directly assigned to the specified user. effective=true: Retrieves "Effective Roles", which include all roles directly and indirectly assigned to the specified user, such as roles directly assigned to them or roles associated through groups.
	POST	api/v2/users/{id}/groups/assign	The API assigns groups to the specified user.
	POST	api/v2/users/{id}/groups/unassign	The API removes the groups assigned to the specified user.
	POST	api/v2/users/{id}/roles/assign	The API assigns roles to the specified user.
	POST	api/v2/users/{id}/roles/unassign	The API removes the roles assigned to the specified user.
roles	GET	api/v2/roles/{id}	The API retrieves details about the role with the specified ID.
	PUT	api/v2/roles/{id}	The API updates the information for the role with the specified ID.
	GET	api/v2/roles/{id}/users	The API retrieves users assigned to the specified role.
	GET	api/v2/roles/{id}/groups	The API retrieves groups assigned to the specified role.
	GET	api/v2/roles/{id}/roles	The API retrieves other roles associated with the specified role.
	POST	api/v2/roles/{id}/groups/assign	The API assigns groups to a specified role.
	POST	api/v2/roles/{id}/groups/unassign	The API removes groups assigned to a specified role.
	POST	api/v2/roles/{id}/roles/associate	The API associates new related roles with the specified role.
	POST	api/v2/roles/{id}/roles/dissociate	The API removes the association between the specified role and the associated roles.
	POST	api/v2/roles/{id}/users/assign	The API assigns users to the specified role.
	POST	api/v2/roles/{id}/users/unassign	The API removes users assigned to the specified role.
groups	GET	api/v2/groups/{id}	The API retrieves details about a group with the specified ID.
	PUT	api/v2/groups/{id}	The API updates information about a group with the specified ID.
	GET	api/v2/groups/{id}/users	The API retrieves users belonging to the specified group.
	GET	api/v2/groups/{id}/roles	effective=false or not specified: Retrieves roles directly assigned to the specified group effective=true: Retrieves "Effective Roles", which include all roles directly and indirectly assigned to the specified group.
	GET	api/v2/groups/{id}/group-relations	The API retrieves associated groups for the specified group.
	GET	api/v2/groups/{id}/gitlab-members	The API retrieves members registered in GitLab groups associated with the specified group.
	POST	api/v2/groups/{id}/groups/relate	The API sets associated groups for the specified group.
	POST	api/v2/groups/{id}/groups/unrelate	The API removes associated groups for the specified group.
	POST	api/v2/groups/{id}/roles/assign	The API assigns roles to the specified group.
	POST	api/v2/groups/{id}/roles/unassign	The API removes roles assigned to the specified group.
	POST	api/v2/groups/{id}/users/assign	The API assigns users to the specified group.
	POST	api/v2/groups/{id}/users/unassign	The API removes users assigned to the specified group.

(Table) List of Standard API functions (oauth2)

Category	Method	URL	Function
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

Category	Method	URL	Function
customers	GET	/capi/v1/customers	The API obtains a list of customers.
customer-users	GET	/capi/v1/customer-users	The API obtains a list of customer users.
agents	GET	/capi/v1/agents	The API obtains a list of assignees.
tickets	GET	/capi/v1/tickets	The API obtains a list of tickets.
	POST	/capi/v1/tickets	The API creates tickets.
	DELETE	/capi/v1/tickets	The API deletes multiple tickets.
	GET	/capi/v1/tickets/{id}	The API obtains detailed information about a ticket.
	PATCH	/capi/v1/tickets/{id}	The API updates some of the information on the ticket.
	GET	/capi/v1/tickets/{id}/related-tickets	The API obtains related ticket information for tickets.
queues	GET	/capi/v1/queues	The API obtains OTOBO queue information.
Watcher-candidates	GET	/capi/v1/tickets/{id}/watcher-candidates	The API obtains watcher candidates related to tickets.
Watchers	GET	/capi/v1/tickets/{id}/watchers	The API obtains watchers related to tickets.
	POST	/capi/v1/tickets/{id}/watchers	The API creates watchers related to tickets.
	DELETE	/capi/v1/tickets/{id}/watchers/{username}	The API deletes watchers related to tickets.
ticket-settings/approval	GET	/capi/v1/ticket-settings/approval	The API obtains settings for the approval function.
	POST	/capi/v1/ticket-settings/approval	The API creates settings for the approval function.
	PUT	/capi/v1/ticket-settings/approval/{id}	The API updates settings for the approval function.
	DELETE	/capi/v1/ticket-settings/approval/{id}	The API deletes settings for the approval function.
knowledge-articles	POST	/capi/v1/knowledge-articles/{id}/vote	The API rates a knowledge article.
	GET	/capi/v1/knowledge-articles	The API obtains a list of knowledge articles.
	GET	/capi/v1/knowledge-articles/{id}	The API obtains details about a knowledge article.
	GET	/capi/v1/knowledge-articles/{id}/attachments	The API obtains a list of attachments for a knowledge article.
knowledge-categories	GET	/capi/v1/knowledge-categories	The API obtains a list of categories for a knowledge article.