Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update id references #4472

Merged
merged 4 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/apis-tools/administration-api/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Make sure you keep the generated client credentials in a safe place. The **Clien

## Set up authentication

If you're interested in how we use a library to handle auth for our code, or to get started, examine the `auth.js` file in the GitHub repository. This file contains a function named `getAccessToken` which executes an OAuth 2.0 protocol to retrieve authentication credentials based on your client id and client secret. Then, we return the actual token that can be passed as an authorization header in each request.
If you're interested in how we use a library to handle auth for our code, or to get started, examine the `auth.js` file in the GitHub repository. This file contains a function named `getAccessToken` which executes an OAuth 2.0 protocol to retrieve authentication credentials based on your client ID and client secret. Then, we return the actual token that can be passed as an authorization header in each request.

To set up your credentials, create an `.env` file which will be protected by the `.gitignore` file. You will need to add your `CLUSTER_ID`, `ADMINISTRATION_CLIENT_ID`, `ADMINISTRATION_CLIENT_SECRET`, `ADMINISTRATION_AUDIENCE`, which is `api.cloud.camunda.io` in a Camunda 8 SaaS environment, and `ADMINISTRATION_API_URL`, which is `https://api.cloud.camunda.io`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Ensure you [authenticate](./camunda-api-rest-authentication.md) before accessing
For SaaS: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v2/`, and for Self-Managed installations: `http://localhost:8080/v2/`.

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
Find your region and cluster ID under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Zeebe component.
:::
Expand Down
6 changes: 3 additions & 3 deletions docs/apis-tools/community-clients/go-client/go-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Now, we need a simple process we can deploy. Later, we will extend the process w

![model-process-step-1](assets/order-process-simple.png)

3. Set the ID (the BPMN process id) to `order-process` instead of the autogenerated value so it's easier to work with in this example.
3. Set the ID (the BPMN process ID) to `order-process` instead of the autogenerated value so it's easier to work with in this example.

4. [Optional] Download the BPMN file to the root of the project.

Expand All @@ -157,7 +157,7 @@ Now, we need a simple process we can deploy. Later, we will extend the process w

![model-process-step-1](assets/order-process-simple.png)

3. Set the ID (the BPMN process id) to `order-process` instead of the autogenerated value so it's easier to work with in this example.
3. Set the ID (the BPMN process ID) to `order-process` instead of the autogenerated value so it's easier to work with in this example.

4. Place the BPMN diagram in the root of the project.

Expand All @@ -169,7 +169,7 @@ Now, we need a simple process we can deploy. Later, we will extend the process w

Next, we want to deploy the modeled process to the broker.

The broker stores the process under its BPMN process id and assigns a version.
The broker stores the process under its BPMN process ID and assigns a version.

<Tabs groupId="modeler" defaultValue="web" queryString values={
[
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/node-js-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ The last step is to create a process instance.

There are two options for creating a process instance:

- For long-running processes, use `createProcessInstance`, which returns as soon as the process instance is created with the process instance id.
- For long-running processes, use `createProcessInstance`, which returns as soon as the process instance is created with the process instance ID.
- For the shorter-running process we are using, use `createProcessInstanceWithResult`, which awaits the completion of the process and returns with the final variable values.

1. Locate the following line in the `main` function:
Expand Down
4 changes: 2 additions & 2 deletions docs/apis-tools/operate-api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Work with this API in our [Postman collection](https://www.postman.com/camundate
For SaaS: `https://${REGION}.operate.camunda.io:443/${CLUSTER_ID}/v1/`, and for Self-Managed installations: `http://localhost:8080/v1/`.

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
Find your region and cluster ID under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Operate component.
:::
Expand All @@ -35,7 +35,7 @@ A Swagger UI is also available within a running instance of Operate, at `https:/
For SaaS: `https://${REGION}.operate.camunda.io/${CLUSTER_ID}/swagger-ui.html`, and for Self-Managed installations: `http://localhost:8080/swagger-ui.html`.

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
Find your region and cluster ID under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
:::

## Multi-tenancy
Expand Down
10 changes: 5 additions & 5 deletions docs/apis-tools/operate-api/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ body,
```js
async function fetchDiagram() {
return fetch(
// Replace {PROCESS_DEFINITION_ID} with a process definition id.
// Replace {PROCESS_DEFINITION_ID} with a process definition ID.
// http://localhost:3030 is the URL of the Proxy server, which should stay the same.
"http://localhost:3030/v1/process-definitions/{PROCESS_DEFINITION_ID}/xml",
{
Expand Down Expand Up @@ -180,12 +180,12 @@ async function fetchDiagram() {

## Show statistics on the diagram

1. Add a new function to the `api.js` file that fetches the flow node statistics for a specified process instance id:
1. Add a new function to the `api.js` file that fetches the flow node statistics for a specified process instance ID:

```js
async function fetchStatistics() {
return fetch(
// Replace {PROCESS_INSTANCE_ID} with a process instance id.
// Replace {PROCESS_INSTANCE_ID} with a process instance ID.
// http://localhost:3030 is the URL of the proxy server, which should stay the same.
"http://localhost:3030/v1/process-instances/{PROCESS_INSTANCE_ID}/statistics",
{
Expand Down Expand Up @@ -230,12 +230,12 @@ fetchStatistics()

## Highlight processed sequence flows on the diagram

1. Add a new function to the `api.js` file that fetches the processed sequence flows for a specified process instance id:
1. Add a new function to the `api.js` file that fetches the processed sequence flows for a specified process instance ID:

```js
async function fetchSequenceFlows() {
return fetch(
// Replace {PROCESS_INSTANCE_ID} with a process instance id.
// Replace {PROCESS_INSTANCE_ID} with a process instance ID.
// http://localhost:3030 is the URL of the Proxy server, which should stay the same.
"http://localhost:3030/v1/process-instances/{PROCESS_INSTANCE_ID}/sequence-flows",
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ curl -X 'PATCH' \

### Unassign task

Unassign a task with the provided id. This returns the task.
Unassign a task with the provided ID. This returns the task.

#### URL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Variables API controller provides an API to query variables.

### Get variable

Get the variable details by variable id.
Get the variable details by variable ID.

#### URL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Ensure you [authenticate](./tasklist-api-rest-authentication.md) before accessin
For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/v1/`, and for Self-Managed installations: `http://localhost:8080/v1/`.

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
Find your region and cluster ID under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Tasklist component.
:::
Expand All @@ -34,7 +34,7 @@ A detailed API description is also available as a Swagger UI at `https://${base-
For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`, and for Self-Managed installations: [`http://localhost:8080/swagger-ui/index.html`](http://localhost:8080/swagger-ui/index.html).

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
Find your region and cluster ID under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).
:::

## API in Postman
Expand Down
8 changes: 4 additions & 4 deletions docs/apis-tools/web-modeler-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ On Self-Managed instances no limits are enforced.

### What is the difference between _simplePath_ and _canonicalPath_?

In Web Modeler you can have multiple files with the same name, multiple folders with the same name, and even multiple projects with the same name. Internally, duplicate names are disambiguated by unique ids.
In Web Modeler you can have multiple files with the same name, multiple folders with the same name, and even multiple projects with the same name. Internally, duplicate names are disambiguated by unique IDs.

The API gives you access to the names, as well as the ids. For example, when requesting a file you will get the following information:
The API gives you access to the names, as well as the IDs. For example, when requesting a file you will get the following information:

- **simplePath** contains the human-readable path. This path may be ambiguous or may have ambiguous elements (e.g. folders) in it.
- **canonicalPath** contains the unique path. It is a list of **PathElementDto** objects which contain the id and the name of the element.
- **canonicalPath** contains the unique path. It is a list of **PathElementDto** objects which contain the ID and the name of the element.

Internally, the ids are what matters. You can rename files or move files between folders and projects and the id will stay the same.
Internally, the IDs are what matters. You can rename files or move files between folders and projects and the ID will stay the same.
2 changes: 1 addition & 1 deletion docs/apis-tools/web-modeler-api/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Make sure you keep the generated client credentials in a safe place. The **Clien

## Set up authentication

If you're interested in how we use a library to handle auth for our code, or to get started, examine the `auth.js` file in the GitHub repository. This file contains a function named `getAccessToken` which executes an OAuth 2.0 protocol to retrieve authentication credentials based on your client id and client secret. Then, we return the actual token that can be passed as an authorization header in each request.
If you're interested in how we use a library to handle auth for our code, or to get started, examine the `auth.js` file in the GitHub repository. This file contains a function named `getAccessToken` which executes an OAuth 2.0 protocol to retrieve authentication credentials based on your client ID and client secret. Then, we return the actual token that can be passed as an authorization header in each request.

To set up your credentials, create an `.env` file which will be protected by the `.gitignore` file. You will need to add your `MODELER_CLIENT_ID`, `MODELER_CLIENT_SECRET`, `MODELER_AUDIENCE`, which is `modeler.cloud.camunda.io` in a Camunda 8 SaaS environment, and `MODELER_BASE_URL`, which is `https://modeler.camunda.io/api/v1`.

Expand Down
26 changes: 13 additions & 13 deletions docs/apis-tools/zeebe-api/gateway-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ message ActivatedJob {
// JSON document, computed at activation time, consisting of all visible variables to
// the task scope
string variables = 13;
// the id of the tenant that owns the job
// the ID of the tenant that owns the job
string tenantId = 14;
}
```
Expand Down Expand Up @@ -118,7 +118,7 @@ message BroadcastSignalRequest {
// the signal variables as a JSON document; to be valid, the root of the document must be an
// object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
string variables = 2;
// the id of the tenant that owns the signal.
// the ID of the tenant that owns the signal.
string tenantId = 3;
}
```
Expand All @@ -129,7 +129,7 @@ message BroadcastSignalRequest {
message BroadcastSignalResponse {
// the unique ID of the signal that was broadcasted.
int64 key = 1;
// the tenant id of the signal that was broadcasted.
// the tenant ID of the signal that was broadcasted.
string tenantId = 2;
}
```
Expand Down Expand Up @@ -475,7 +475,7 @@ message EvaluatedDecisionInput {
}

message EvaluatedDecisionOutput {
// the id of the evaluated decision output
// the ID of the evaluated decision output
string outputId = 1;
// the name of the evaluated decision output
string outputName = 2;
Expand All @@ -484,7 +484,7 @@ message EvaluatedDecisionOutput {
}

message MatchedDecisionRule {
// the id of the matched rule
// the ID of the matched rule
string ruleId = 1;
// the index of the matched rule
int32 ruleIndex = 2;
Expand Down Expand Up @@ -729,7 +729,7 @@ message ModifyProcessInstanceRequest {
optional uint64 operationReference = 4;

message ActivateInstruction {
// the id of the element that should be activated
// the ID of the element that should be activated
string elementId = 1;
// the key of the ancestor scope the element instance should be created in;
// set to -1 to create the new element instance within an existing element
Expand All @@ -746,13 +746,13 @@ message ModifyProcessInstanceRequest {
// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
// valid argument, as the root of the JSON document is an array and not an object.
string variables = 1;
// the id of the element in which scope the variables should be created;
// the ID of the element in which scope the variables should be created;
// leave empty to create the variables in the global scope of the process instance
string scopeId = 2;
}

message TerminateInstruction {
// the id of the element that should be terminated
// the ID of the element that should be terminated
int64 elementInstanceKey = 1;
}
}
Expand All @@ -779,11 +779,11 @@ Returned if:
Returned if:

- At least one activate instruction is invalid. An activate instruction is considered invalid if:
- The process doesn't contain an element with the given id.
- The process doesn't contain an element with the given ID.
- A flow scope of the given element can't be created.
- The given element has more than one active instance of its flow scope.
- At least one variable instruction is invalid. A variable instruction is considered invalid if:
- The process doesn't contain an element with the given scope id.
- The process doesn't contain an element with the given scope ID.
- The given element doesn't belong to the activating element's flow scope.
- The given variables are not a valid JSON document.
- At least one terminate instruction is invalid. A terminate instruction is considered invalid if:
Expand Down Expand Up @@ -817,9 +817,9 @@ message MigrateProcessInstanceRequest {
}

message MappingInstruction {
// the element id to migrate from
// the element ID to migrate from
string sourceElementId = 1;
// the element id to migrate into
// the element ID to migrate into
string targetElementId = 2;
}
}
Expand Down Expand Up @@ -1300,7 +1300,7 @@ message ActivatedJob {
// JSON document, computed at activation time, consisting of all visible variables to
// the task scope
string variables = 13;
// the id of the tenant that owns the job
// the ID of the tenant that owns the job
string tenantId = 14;
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ If messages are exchanged between different processes deployed in the workflow e

<span className="callout">1</span>

Use some simple code on the sending side to route the message to a new process instance, e.g. by starting a new process instance by the BPMN id in Java using a JavaDelegate:
Use some simple code on the sending side to route the message to a new process instance, e.g. by starting a new process instance by the BPMN ID in Java using a JavaDelegate:

```java
public class SendOrderReceivedMessageDelegate implements JavaDelegate {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Most events actually occur somewhere external to the workflow engine and need to
- Using API: Receive the message by means of your platform-specific activities such as connecting to a AMQP queue or processing a REST request and then route it to the process.
- Using Connectors: Configure a Connector to receive messages such as Kafka records and rote it to the process. Note that this possibility works for Camunda 8 only.

### Starting process instance by BPMN process id
### Starting process instance by BPMN process ID

If you have only one starting point (none start event) in your process definition, you reference the process definition by the ID in the BPMN XML file.

Expand Down Expand Up @@ -210,7 +210,7 @@ If messages are exchanged between different processes deployed in the workflow e

<span className="callout">1</span>

Use some simple code on the sending side to route the message to a new process instance, e.g. by starting a new process instance by the BPMN id in Java:
Use some simple code on the sending side to route the message to a new process instance, e.g. by starting a new process instance by the BPMN ID in Java:

```java
@JobWorker(type="routeInput")
Expand Down
Loading
Loading