IBM Banking Process and Service Models

https://www.ibm.com/docs/en/bps
Admin
IBM Banking Process and Service Models provides documentation and resources for various versions of...
Tokens:275,274
Snippets:2,709
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /customers

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-properties-creation-collection-resource

Retrieves a collection of Customer resources.

```APIDOC
## GET /customers

### Description
Returns Customer resources.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter criteria for the retrieval.

#### Request Body
(Not applicable for GET requests)

### Response
#### Success Response (200 OK)
- **(No specific fields defined)** - Description: A list of Customer resources.

#### Response Example
```json
{
  "customers": [
    {
      "id": "123",
      "name": "Customer A",
      "email": "a@example.com"
    },
    {
      "id": "456",
      "name": "Customer B",
      "email": "b@example.com"
    }
  ]
}
```

#### Error Responses
- **400 Bad Request**: Invalid filter parameter.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Resource not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### GET /customers

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-collection-resource

Retrieves a collection of Customer resources. Supports filtering via query parameters.

```APIDOC
## GET /customers

### Description
Returns Customer resources. Supports filtering.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **filter** (String) - Optional - Filters the results based on specified criteria.

#### Request Body
(Not applicable for GET requests)

### Request Example
```json
{
  "filter": "active"
}
```

### Response
#### Success Response (200 OK)
- **Response type** (JAX-RS) - A list of Customer resources.
#### Error Responses
- **400 Bad Request**: Invalid filter parameter.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: No customers found.
- **500 Internal Server Error**: An unexpected server error occurred.
```

--------------------------------

### Data Class Generator Command Syntax

Source: https://www.ibm.com/docs/en/bps/8.10_topic=classes-installing-data-class-generator

Defines the command-line syntax for the data class generator tool, including required parameters and their explanations. This applies to both Windows and Linux/macOS executions.

```plaintext
GlossaryTools.bat <toolname> <hostport> <username> <password>
<toolname> - This should be the name of the glossary tool. Valid values are: [dataclass]
<hostport> - IBM IGC host information. Should include the prefix, e.g.: https://, and the port postfix :443/
<username> - IBM IGC login username. The user should have sufficient privileges for the functionality of the tool
<password> - IBM IGC login password for the supplied username
```

--------------------------------

### GET /customer/{customerId}

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-member-resource

Retrieves a Customer resource. Requires the customerId as a path parameter and produces JSON.

```APIDOC
## GET /customer/{customerId}

### Description
Retrieves a Customer resource.

### Method
GET

### Endpoint
/customer/{customerId}

### Parameters
#### Path Parameters
- **customerId** (String) - Required - The ID of the customer to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **customer** (Customer_RDO) - The Customer resource details.

#### Response Example
```json
{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john.doe@example.com"
}
```

#### Error Responses
- **400 Bad Request**: Invalid input.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Customer not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### Execute Data Class Generator (Linux/macOS)

Source: https://www.ibm.com/docs/en/bps/8.10_topic=classes-installing-data-class-generator

Commands to make the data class generator script executable on Linux or macOS and then execute it. Similar to Windows, it requires tool name, IGC host/port, username, and password.

```bash
chmod +x GlossaryTools
GlossaryTools dataclass https://igc.fyre.ibm.com:443/ user1 pass123
```

--------------------------------

### Data Class Generator Optional Parameters

Source: https://www.ibm.com/docs/en/bps/8.10_topic=classes-installing-data-class-generator

Lists and explains the optional parameters for the data class generator, such as batch mode, maximum items, value definition handling, and value list formatting. These parameters allow customization of the generator's behavior.

```plaintext
-help. To get this more information message.
-batchmode:true or -batchmode:false. Default is false. Indicates if generator runs in batch, or not batch (user confirms each group of data classes to add).
-maxitems:<integer>. Default is 2000. This indicates the maximum number of items that will be returned from glossary calls. If all expected data classes are not being created, this number might need to be increased.
-valuedef:true or -valuedef:false. Default is true. If a definition exists on a value, this indicates whether it should be then appended to the long definition of the generated data class (as data class values themselves, cannot have definitions).
-values:code or -values:name or -values:codeandname. Default is codeandname. Whether the data class list of values should be made up from code, names or codes and names. This could depend on: whether codes and names exist; how representative the codes and names, are of the data sources that ultimately need to be classified by the data classes.
```

--------------------------------

### GET /api/resources

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-properties-creation-collection-resource

Retrieves a collection of resources, optionally filtered by a query parameter. Returns a 200 OK status with a list of resources on success.

```APIDOC
## GET /api/resources

### Description
Returns Customer resources.

### Method
GET

### Endpoint
/api/resources

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Allows filtering the results (e.g., ?filter=active).

#### Response
#### Success Response (200 OK)
- **Response type** (array) - An array of Customer resources.

#### Response Example
```json
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
]
```

#### Error Responses
- **400 Bad Request**
- **401 Unauthorized**
- **403 Forbidden**
- **404 Not Found**
- **500 Internal Server Error**
```

--------------------------------

### Execute Data Class Generator (Windows)

Source: https://www.ibm.com/docs/en/bps/8.10_topic=classes-installing-data-class-generator

Command to execute the data class generator tool on Windows. It requires the tool name, IGC host/port, username, and password as arguments. The tool name must be 'dataclass'.

```batch
GlossaryTools.bat dataclass https://igc.fyre.ibm.com:443/ user1 pass123
```

--------------------------------

### GET Customer Resource

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-properties-creation-member-resource

Retrieves a Customer resource using its unique identifier. Returns the customer details upon successful retrieval.

```APIDOC
## GET /websites/ibm_en_bps/customers/{customerId}

### Description
Returns a Customer resource.

### Method
GET

### Endpoint
/websites/ibm_en_bps/customers/{customerId}

### Parameters
#### Path Parameters
- **customerId** (String) - Required - The unique identifier of the customer to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **customer** (Customer_RDO) - The retrieved customer resource object.

#### Response Example
```json
{
  "customer": {
    "customerId": "string",
    "name": "string",
    "email": "string"
  }
}
```

#### Error Responses
- **400 Bad Request** - Invalid input provided.
- **401 Unauthorized** - Authentication failed.
- **403 Forbidden** - Insufficient permissions.
- **404 Not Found** - The customer resource was not found.
- **500 Internal Server Error** - An unexpected error occurred.
```

--------------------------------

### Query Parameters for Resource Operations

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-query-parameters

This section describes the standard query parameters that can be used in GET operations for Collection and Member Resources.

```APIDOC
## GET /websites/ibm_en_bps

### Description
This endpoint supports various query parameters for retrieving resource collections and member resources. These parameters allow for sorting, filtering, searching, paging, and expanding associated resources.

### Method
GET

### Endpoint
/websites/ibm_en_bps

### Parameters
#### Query Parameters
- **_sort** (string) - Optional - Sort by specified fields in ascending (+) or descending (-) order. Sub-fields can be specified within {}. Example: `+field1,-field2{+sub_field1,-sub_field2}`
- **_fields** (string) - Optional - Field names to include. Supports dot notation for sub-fields and hyphen notation to exclude fields. Example: `field1,field2.field3` or `field1,-field2`
- **_detail_level** (string) - Optional - Specifies the level of detail for fields to include. Supported values: `minimal`, `standard`, `complete`.
- **_offset** (number) - Optional - The beginning item to return (zero-based index) for paginated results.
- **_limit** (number) - Optional - Maximum number of items to return for paginated results. Services should define default and maximum values.
- **_expand** (string) - Optional - Resource names to expand, provided as a comma-separated list. Example: `resource1,resource2`

#### Search Aliases
- **<query alias>** (string) - Optional - Create a query alias for specific search operations on a resource collection by mapping it to a query parameter and its values. Example: `_ref=XYZ` for an alias `_ref`.

### Request Example
```
GET /websites/ibm_en_bps?_sort=-created&_fields=name,address.postCode&_limit=25&_expand=author
```

### Response
#### Success Response (200)
- **Resources** (array) - A list of resource objects matching the query criteria.

#### Response Example
```json
{
  "resources": [
    {
      "id": "123",
      "name": "Example Website",
      "address": {
        "postCode": "SW1A 0AA"
      },
      "author": {
        "id": "author456",
        "name": "Example Author"
      }
    }
  ]
}
```
```

--------------------------------

### Member Resource Properties - Operations

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-member-resource

Defines the operation properties required for a Member Resource, including DELETE, GET, and PUT operations.

```APIDOC
## Member Resource Operations

### DELETE operation
- **Type**: (1,1)
- **Description**: Represents an operation to delete a resource.
- **Example**: deleteCustomer

### GET operation
- **Type**: (1,1)
- **Description**: Represents a retrieval operation in a resources.
- **Example**: getCustomer

### PUT operation
- **Type**: (1,1)
- **Description**: Represents an operation to change the state of a resource.
- **Example**: updateCustomer
```

--------------------------------

### Searching Query Parameters

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-query-parameters

Allows searching on relevant GET operations for Collection Resources by defining query aliases for specific search criteria.

```APIDOC
## GET /resource?_query_alias=<param_name>=<param_values>

### Description
Searches a collection resource using predefined query aliases.

### Method
GET

### Endpoint
/resource

### Query Parameters
- **<query_alias>** (string) - Required - A defined alias for a specific search query. The actual parameter name is `_<param_name>`.

### Request Example
`../customers/external_reference?_ref=XYZ`

### Response
#### Success Response (200)
- **(search results)** - Description of the resources matching the search criteria.
```

--------------------------------

### Paging Query Parameters in API Calls

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-query-parameters

This section covers the '_offset' and '_limit' query parameters for paginating results from collection resources. '_offset' specifies the starting item (zero-based), and '_limit' sets the maximum number of items to return.

```URL
../customers?_offset=0&_limit=50
```

```URL
../customers?_offset=300&_limit=25
```

--------------------------------

### GET /member-resource/{resourceId}

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-properties-creation-member-resource

Retrieves a specific Member Resource identified by its unique ID.

```APIDOC
## GET /member-resource/{resourceId}

### Description
Returns a Customer resource.

### Method
GET

### Endpoint
/member-resource/{resourceId}

### Parameters
#### Path Parameters
- **resourceId** (String) - Required - The unique identifier of the resource to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **customer** (Customer_RDO) - The retrieved customer resource.

#### Response Example
```json
{
  "customer": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
}
```

#### Error Responses
- **400 Bad Request**: Invalid request format.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Resource not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### Paging Query Parameters

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-query-parameters

Supports pagination on GET operations for large Collection Resources, allowing control over the offset and limit of returned items.

```APIDOC
## GET /resource?_offset=<number>&_limit=<number>

### Description
Retrieves a paginated subset of items from a large collection resource.

### Method
GET

### Endpoint
/resource

### Query Parameters
- **_offset** (integer) - Optional - The zero-based index of the first item to return.
- **_limit** (integer) - Optional - The maximum number of items to return. Each service defines a default and maximum allowable value.

### Request Example
`../customers?_offset=0&_limit=50`
`../customers?_offset=300&_limit=25`

### Response
#### Success Response (200)
- **(paginated list of items)** - Description of the items returned within the specified offset and limit.
```

--------------------------------

### Expanding Resources Query Parameters

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-query-parameters

Supports expanding associated resources on relevant GET operations for Collection and Member Resources, allowing embedding of linked resource data.

```APIDOC
## GET /resource?_expand=<resource1>,<resource2>

### Description
Expands associated resources by embedding their data within the response of a collection or member resource.

### Method
GET

### Endpoint
/resource

### Query Parameters
- **_expand** (string) - Optional - A comma-separated list of resource names to expand. Resource names must match the names of resources embedded in the response.

### Request Example
`../customers/123?_expand=orders,addresses`

### Response
#### Success Response (200)
- **(resource with expanded data)** - Description of the primary resource with embedded data from the expanded resources.
```

--------------------------------

### Sorting Query Parameters

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-query-parameters

Supports sorting on relevant GET operations for Collection and Member Resources. You can sort by specified fields in ascending or descending order, and specify sub-fields for sorting.

```APIDOC
## GET /resource?_sort=<field1>,+<field2>

### Description
Sorts a collection or member resource by specified fields.

### Method
GET

### Endpoint
/resource

### Query Parameters
- **_sort** (string) - Required - Comma-separated list of fields to sort by. Use '+' for ascending and '-' for descending order. Sub-fields can be specified within {} with their own sort order (e.g., `field1{+sub_field1,-sub_field2}`).

### Request Example
`../customers/123?_sort=name{+surname,+firstName},-created`

### Response
#### Success Response (200)
- **(fields determined by sort)** - Description of fields returned after sorting.
```

--------------------------------

### Filtering Query Parameters

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-query-parameters

Enables filtering of relevant GET operations for Collection and Member Resources. You can specify fields to include, exclude, or use predefined detail levels.

```APIDOC
## GET /resource?_fields=<field1>,<field2>

### Description
Filters the fields returned in the response for a collection or member resource.

### Method
GET

### Endpoint
/resource

### Query Parameters
- **_fields** (string) - Optional - Comma-separated list of field names to include. Use '.' notation for sub-fields (e.g., `name.firstName`) and '-' to exclude fields (e.g., `name,-address`).
- **_detail_level** (string) - Optional - Specifies the level of detail for the fields returned. Supported values: `minimal`, `standard`, `complete`.

### Request Example
`../customers/123?_fields=name.firstName,name.surname,dateOfBirth,address.postCode`
`../customers/123?_fields=name,-address`
`../customers/123?_detail_level=minimal`

### Response
#### Success Response (200)
- **(filtered fields)** - Description of fields returned after filtering.
```

--------------------------------

### JSON Array String Example for Enumeration Values

Source: https://www.ibm.com/docs/en/bps/8.10_topic=classes-enumeration-terms-custom-attribute

This snippet demonstrates the expected JSON array string format for the 'Enumeration_Values' custom attribute. It includes objects with 'Code', 'Name', and 'Definition' fields, which the generator uses to populate the data class.

```json
[{"Code": "Code111", "Name": "Code Name One", "Definition": "A definition for code name one"}, 
{"Code": "Code222", "Name": "Code Name Two", "Definition": "A definition for code name two"}]
```

--------------------------------

### POST /customers

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-properties-creation-collection-resource

Creates a new Customer resource.

```APIDOC
## POST /customers

### Description
Creates a Customer resource.

### Method
POST

### Endpoint
/customers

### Parameters
#### Request Body
- **Name** (string) - Required - A textual name of the operation.
- **Description** (string) - Required - A complete and unambiguous description of the class including one or more business examples to facilitate understanding by users.
- **Input parameter** (Customer_RDO) - Required - Represents the parameter types of a method parameter, field, or method.
- **Return parameter** (any) - Required - Response type.
- **Produces** (string) - Required - Specifies a list of media types that can be produced. Example: MediaType.APPLICATION_JSON
- **Consumes** (string) - Required - Specifies a list of media types that can be consumed. Example: MediaType.APPLICATION_JSON

### Request Example
```json
{
  "Name": "createCustomer",
  "Description": "Creates a Customer resource.",
  "Input parameter": "customer (Customer_RDO)",
  "Return parameter": "Response type in JAX-RS",
  "Produces": "MediaType.APPLICATION_JSON",
  "Consumes": "MediaType.APPLICATION_JSON"
}
```

### Response
#### Success Response (201 Created)
- **(No specific fields defined)** - Description: Indicates successful creation.

#### Error Responses
- **400 Bad Request**: Invalid input data.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Resource not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### POST /customers

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-collection-resource

Creates a new Customer resource. Accepts customer details in the request body and returns a success status.

```APIDOC
## POST /customers

### Description
Creates a Customer resource.

### Method
POST

### Endpoint
/customers

### Parameters
#### Request Body
- **customer** (Customer_RDO) - Required - Details of the customer to create.
- **Produces** (MediaType) - Required - Specifies the media type, e.g., MediaType.APPLICATION_JSON.

### Request Example
```json
{
  "customer": {
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "produces": "MediaType.APPLICATION_JSON"
}
```

### Response
#### Success Response (201 Created)
- **Response type** (JAX-RS) - The response from the server.
#### Error Responses
- **400 Bad Request**: Invalid input provided.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: The requested resource was not found.
- **500 Internal Server Error**: An unexpected server error occurred.
```

--------------------------------

### RESTful API Modelling: Defining REST Resources

Source: https://www.ibm.com/docs/en/bps/8_topic=modelling-defining-rest-resources

This documentation describes the concept of a REST resource as an addressable artifact on the web and how to define them using the IBM Industry Models RADM. It covers the use of Path Dependencies to construct resource URIs.

```APIDOC
## Defining REST Resources

A resource is an addressable artefact on the web. Resources can have links to other resources, controlled by <<Path>> dependency relationships which dictate how resource URIs are constructed.

### Key Resources in Banking RADM Example:
- Organizations
- Customers
- Accounts
- Payments

### Path Dependencies between Resources
Resources can be logically chained using a specified format, e.g., `../organizations/{organization_id}/customers/{customer_id}/accounts/{account_id}/payments/{payments_id}`. This is achieved by adding Path Dependencies between resources, such as between CustomersResource and AccountsResource.
```

--------------------------------

### POST /api/resources

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-properties-creation-collection-resource

Creates a new resource with the provided attributes. Expects a JSON request body and returns a 201 Created status on success.

```APIDOC
## POST /api/resources

### Description
Creates a Customer resource.

### Method
POST

### Endpoint
/api/resources

### Parameters
#### Request Body
- **Name** (string) - Required - A textual name of the operation (e.g., createCustomer).
- **Description** (string) - Required - A complete and unambiguous description of the class including one or more business examples.
- **Input parameter** (object) - Required - Represents the parameter types of a method parameter (e.g., customer (Customer_RDO)).
- **Return parameter** (object) - Required - The expected response type.
- **Produces** (string) - Required - Specifies the media type produced (e.g., MediaType.APPLICATION_JSON).
- **Consumes** (string) - Required - Specifies the media type consumed (e.g., MediaType.APPLICATION_JSON).

### Request Example
```json
{
  "Name": "createCustomer",
  "Description": "Creates a Customer resource.",
  "Input parameter": {"type": "Customer_RDO"},
  "Return parameter": {},
  "Produces": "MediaType.APPLICATION_JSON",
  "Consumes": "MediaType.APPLICATION_JSON"
}
```

### Response
#### Success Response (201 Created)
- **Response type** (object) - The response from the creation operation.

#### Error Responses
- **400 Bad Request**
- **401 Unauthorized**
- **403 Forbidden**
- **404 Not Found**
- **500 Internal Server Error**
```

--------------------------------

### Paging Query Parameters

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-query-parameters

Parameters to control pagination for retrieving large collections of resources.

```APIDOC
## GET /resources

### Description
Retrieves a paginated collection of resources.

### Method
GET

### Endpoint
/resources

### Query Parameters
- **_offset** (integer) - Optional - The zero-based starting index of the items to return.
  * Example: `_offset=0`
- **_limit** (integer) - Optional - The maximum number of items to return in the response. Services should define default and maximum values.
  * Example: `_limit=50`
```

--------------------------------

### Searching Query Parameters

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-query-parameters

Parameters to enable searching within resource collections using query aliases.

```APIDOC
## GET /resources/search

### Description
Searches within a resource collection based on a query alias.

### Method
GET

### Endpoint
/resources/search

### Query Parameters
- **<query alias>** (string) - Required - The alias defined for a specific search query. This alias maps to specific query parameters and values.
  * Example: `_ref=XYZ` (assuming '_ref' is a defined query alias for a search)
```

--------------------------------

### PUT /customer/{customerId}

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-member-resource

Updates a Customer resource. Requires the customerId as a path parameter and accepts/produces JSON.

```APIDOC
## PUT /customer/{customerId}

### Description
Updates a Customer resource.

### Method
PUT

### Endpoint
/customer/{customerId}

### Parameters
#### Path Parameters
- **customerId** (String) - Required - The ID of the customer to update.

#### Query Parameters
None

#### Request Body
- **customer** (Customer_RDO) - Required - The Customer resource with updated fields.

### Request Example
```json
{
  "name": "John Doe Updated",
  "email": "john.doe.updated@example.com"
}
```

### Response
#### Success Response (200)
- **Description** (string) - Indicates the result of the update operation.

#### Response Example
```json
{
  "message": "Customer updated successfully."
}
```

#### Error Responses
- **400 Bad Request**: Invalid input.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Customer not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### DELETE /customer/{customerId}

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-member-resource

Deletes a Customer resource. Requires the customerId as a path parameter and produces JSON.

```APIDOC
## DELETE /customer/{customerId}

### Description
Deletes a Customer resource.

### Method
DELETE

### Endpoint
/customer/{customerId}

### Parameters
#### Path Parameters
- **customerId** (String) - Required - The ID of the customer to delete.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200, 204)
- **Description** (string) - Indicates the result of the operation.

#### Response Example
```json
{
  "message": "Customer deleted successfully."
}
```

#### Error Responses
- **400 Bad Request**: Invalid input.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Customer not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### Filtering Query Parameters in API Calls

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-query-parameters

This section explains the use of '_fields' and '_detail_level' query parameters for filtering resource data. '_fields' allows specifying fields to include or exclude using dot notation and negation, while '_detail_level' sets predefined field sets.

```URL
../customers/123?_fields=name.firstName,name.surname,dateOfBirth,address.postCode
```

```URL
../customers/123?_fields=name,-address
```

```URL
../customers/123?_detail_level=minimal
```

--------------------------------

### Expanding Resources Query Parameters

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-query-parameters

Parameters to control the expansion of associated resources within a response.

```APIDOC
## GET /resources

### Description
Retrieves resources with specified associated resources expanded.

### Method
GET

### Endpoint
/resources

### Query Parameters
- **_expand** (string) - Optional - A comma-separated list of resource names to expand within the response.
  * Example: `_expand=resource1,resource2`
```

--------------------------------

### Sorting Query Parameters in API Calls

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-query-parameters

This section details how to use the '_sort' query parameter for ordering resources. It supports ascending ('+') and descending ('-') order for specified fields, and allows sub-field sorting within curly braces.

```URL
../customers/123?_sort=name{+surname,+firstName},-created
```

--------------------------------

### Expanding Resources in API Calls

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-query-parameters

This section explains the '_expand' query parameter, used to include associated resources within a response. It accepts a comma-separated list of resource names to be expanded.

```URL
../customers?_expand=orders,addresses
```

--------------------------------

### PUT Customer Resource

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-properties-creation-member-resource

Updates an existing Customer resource. Requires the customerId in the path and the updated customer data in the request body.

```APIDOC
## PUT /websites/ibm_en_bps/customers/{customerId}

### Description
Updates a Customer resource.

### Method
PUT

### Endpoint
/websites/ibm_en_bps/customers/{customerId}

### Parameters
#### Path Parameters
- **customerId** (String) - Required - The unique identifier of the customer to update.

#### Query Parameters
None

#### Request Body
- **customer** (Customer_RDO) - Required - The customer resource object with updated fields.

### Request Example
```json
{
  "customer": {
    "name": "Updated Name",
    "email": "updated.email@example.com"
  }
}
```

### Response
#### Success Response (200)
- **customer** (Customer_RDO) - The updated customer resource object.

#### Response Example
```json
{
  "customer": {
    "customerId": "string",
    "name": "Updated Name",
    "email": "updated.email@example.com"
  }
}
```

#### Error Responses
- **400 Bad Request** - Invalid input provided.
- **401 Unauthorized** - Authentication failed.
- **403 Forbidden** - Insufficient permissions.
- **404 Not Found** - The customer resource was not found.
- **500 Internal Server Error** - An unexpected error occurred.
```

--------------------------------

### Member Resource Properties - Attributes

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-member-resource

Defines the attribute properties required for a Member Resource, including its Name and Description.

```APIDOC
## Member Resource Attributes

### Name
- **Type**: (1,1)
- **Description**: A textual name of the resource. Typically in singular form.
- **Example**: CustomerResource

### Description
- **Type**: (1,1)
- **Description**: A complete and unambiguous description of the class including one or more business examples to facilitate understanding by users.
- **Example**: A party to whom the modeled organization has sold or wants to sell products. (e.g. Client, Customer, Prospect)
```

--------------------------------

### Sorting Query Parameters

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-query-parameters

Parameters to control the sorting of returned resources. Supports ascending, descending, and sub-field sorting.

```APIDOC
## GET /resources

### Description
Retrieves a collection of resources with specified sorting criteria.

### Method
GET

### Endpoint
/resources

### Query Parameters
- **_sort** (string) - Optional - Specifies the sorting order. Can be a single field or a comma-separated list. Prefix with '+' for ascending and '-' for descending. Sub-fields can be specified using curly braces {} with their own sort order.
  * Example: `_sort=+name,-created`
  * Example: `_sort=name{+surname,-firstName}`
```

--------------------------------

### Collection Resource Properties

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-properties-creation-collection-resource

Defines the essential properties for creating a Collection Resource within the RADM, including attributes, operations, and relationships.

```APIDOC
## Collection Resource Properties

### Description
Properties for the creation of a Collection Resource, including attributes, operations, and relationships.

### Method
N/A (This describes a model definition, not an API endpoint)

### Endpoint
N/A

### Parameters
#### Attributes
- **Name** (String) - Required - A textual name of the resource, typically in plural form.
- **Description** (String) - Required - A complete and unambiguous description of the class including one or more business examples.
- **Id** (String) - Required - The unique identifier for the resource.

#### Operations
- **POST** (1,1) - Required - Represents an operation to create a resource.
- **GET** (1,1) - Required - Represents a retrieval operation on a resource, typically retrieving a collection.
- **SubResourceLocator** (0,n) - Optional - Specifies the path of a JAX-RS subresource.
- **Constructor** (n) - Required - A pair of constructors in every Resource, one without parameters and one that takes an Id parameter.

#### Relationships
- **Path** (0,N) - Optional - Specifies the path from the source resource to the target resource, represented by a Dependency relationship.

### Request Example
```json
{
  "resourceName": "CustomersResource",
  "description": "A group of parties to whom the modeled organization has sold or wants to sell products.",
  "resourceId": "customerId (String)",
  "operations": [
    "POST",
    "GET"
  ],
  "relationships": [
    "/{customerId}",
    "/{customerId}/accounts"
  ]
}
```

### Response
#### Success Response (N/A - Model Definition)
This section describes model properties, not API responses.

#### Response Example
N/A
```

--------------------------------

### Searching with Query Aliases in API Calls

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-query-parameters

This section describes how to use query aliases for searching on collection resources. A query alias is defined with '_<param name>' to represent a specific set of search parameters and values.

```URL
../customers/external_reference?_ref=XYZ
```

--------------------------------

### DELETE Customer Resource

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-properties-creation-member-resource

Deletes a Customer resource. This operation requires a customerId in the path and returns appropriate status codes for success or failure.

```APIDOC
## DELETE /websites/ibm_en_bps/customers/{customerId}

### Description
Deletes a Customer resource.

### Method
DELETE

### Endpoint
/websites/ibm_en_bps/customers/{customerId}

### Parameters
#### Path Parameters
- **customerId** (String) - Required - The unique identifier of the customer to delete.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200, 204)
- **No Content** (204) - The customer was successfully deleted.

#### Error Responses
- **400 Bad Request** - Invalid input provided.
- **401 Unauthorized** - Authentication failed.
- **403 Forbidden** - Insufficient permissions.
- **404 Not Found** - The customer resource was not found.
- **500 Internal Server Error** - An unexpected error occurred.
```

--------------------------------

### Filtering Query Parameters

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-query-parameters

Parameters to filter the fields returned in the response. Supports including specific fields, excluding fields, and detail level filtering.

```APIDOC
## GET /resources

### Description
Retrieves a collection of resources with specified filtering criteria.

### Method
GET

### Endpoint
/resources

### Query Parameters
- **_fields** (string) - Optional - Specifies which fields to include or exclude. Use comma-separated values. Use '.' notation for sub-fields. Use '-' prefix to exclude fields.
  * Example: `_fields=name.firstName,name.surname,dateOfBirth`
  * Example: `_fields=name,-address`
- **_detail_level** (string) - Optional - Specifies the level of detail for the returned fields. Supported values: `minimal`, `standard`, `complete`.
  * Example: `_detail_level=minimal`
```

--------------------------------

### Collection Resource Properties

Source: https://www.ibm.com/docs/en/bps/8_topic=resources-properties-creation-collection-resource

Defines the properties required for creating a Collection Resource within the RESTful API Design Model (RADM). This includes attribute, operation, and relationship properties.

```APIDOC
## Properties for creation of a Collection Resource

### Description
Collection Resources have specific Attributes, Operations, and Relationships which should be created for any new Resources added to the RADM.

### Resource properties

#### Attribute properties

| Attribute | Value | Example |
|---|---|---|
| Name (1,1) | A textual name of the resource. Typically in plural form. | CustomersResource |
| Description (1,1) | A complete and unambiguous description of the class including one or more business examples to facilitate understanding by users. Descriptions form part of the API documentation, and so they will potentially have public visibility. | A group of parties to whom the modeled organization has sold or wants to sell products. e.g. Clients, Customers, Prospects |
| Id (1,1) | Resource ID | customerId (String) |

#### Operation properties

| Operation | Description | Example |
|---|---|---|
| POST (1,1) | Represents an operation to create a resource. | createCustomer |
| GET (1,1) | Represents a retrieval operation in a resources. GET operation on Resource retrieves a collection of Resource thus name it in plural form. | getCustomers |
| SubResourceLocator (0,n) | Specifies the path of a JAX-RS subresource. Generated by RSA function. | getRoadVehiclesResource_roadvehiclesresource |
| Constructor (n) | A pair of constructors in every Resource, one takes no parameters and one that takes an Id parameter | CustomersResource |

#### Relationship properties

| Relationship | Description | Example |
|---|---|---|
| Path (0,N) | Specifies the path from the source resource to the target resource. Represented by Dependency relationship in RSA. Each Resource must have a Path to underlined Member Resource using ID. | (To Member Resource) `/{customerId}`<br>(To other Resource) `/{customerId}/accounts` |
```

--------------------------------

### Collection Resource Properties

Source: https://www.ibm.com/docs/en/bps/8.9_topic=resources-properties-creation-collection-resource

Defines the essential properties for creating a Collection Resource within the RESTful API Design Model (RADM). This includes attribute properties, operation properties, and relationship properties.

```APIDOC
## Properties for creation of a Collection Resource

Collection Resources have specific Attributes, Operations, and Relationships which should be created for any new Resources added to the RADM.

### Attribute properties

| Attribute | Value | Example |
|---|---|---|
| Name (1,1) | A textual name of the resource. Typically in plural form. | CustomersResource |
| Description (1,1) | A complete and unambiguous description of the class including one or more business examples to facilitate understanding by users. Descriptions form part of the API documentation, and so they will potentially have public visibility. | A group of parties to whom the modeled organization has sold or wants to sell products. e.g. Clients, Customers, Prospects |
| Id (1,1) | Resource ID | customerId (String) |

### Operation properties

| Operation | Description | Example |
|---|---|---|
| POST (1,1) | Represents an operation to create a resource. | createCustomer |
| GET (1,1) | Represents a retrieval operation in a resources. GET operation on Resource retrieves a collection of Resource thus name it in plural form. | getCustomers |
| SubResourceLocator (0,n) | Specifies the path of a JAX-RS subresource. Generated by RSA function. | getRoadVehiclesResource_roadvehiclesresource |
| Constructor (n) | A pair of constructors in every Resource, one takes no parameters and one that takes an Id parameter | CustomersResource

### Relationship properties

| Relationship | Description | Example |
|---|---|---|
| Path (0,N) | Specifies the path from the source resource to the target resource. Represented by Dependency relationship in RSA. Each Resource must have a Path to underlined Member Resource using ID. | (To Member Resource) `/{customerId}` <br> (To other Resource) `/{customerId}/accounts`
```

--------------------------------

### PUT /member-resource/{resourceId}

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-properties-creation-member-resource

Updates an existing Member Resource identified by its unique ID.

```APIDOC
## PUT /member-resource/{resourceId}

### Description
Updates a Customer resource.

### Method
PUT

### Endpoint
/member-resource/{resourceId}

### Parameters
#### Path Parameters
- **resourceId** (String) - Required - The unique identifier of the resource to update.

#### Query Parameters
None

#### Request Body
- **customer** (Customer_RDO) - Required - The updated customer resource data.

### Request Example
```json
{
  "customer": {
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  }
}
```

### Response
#### Success Response (200)
- The response indicates success and may contain the updated resource or confirmation.

#### Response Example
```json
{
  "message": "Customer updated successfully.",
  "updatedCustomer": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  }
}
```

#### Error Responses
- **400 Bad Request**: Invalid request format or payload.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Resource not found.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### DELETE /member-resource/{resourceId}

Source: https://www.ibm.com/docs/en/bps/8.10_topic=resources-properties-creation-member-resource

Deletes a specific Member Resource identified by its unique ID.

```APIDOC
## DELETE /member-resource/{resourceId}

### Description
Deletes a Customer resource.

### Method
DELETE

### Endpoint
/member-resource/{resourceId}

### Parameters
#### Path Parameters
- **resourceId** (String) - Required - The unique identifier of the resource to delete.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200, 204)
- The response indicates success if the resource was deleted or if it did not exist (204 No Content).

#### Response Example
```json
// No content for 204
```

#### Error Responses
- **400 Bad Request**: Invalid request format.
- **401 Unauthorized**: Authentication failed.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: Resource not found.
- **500 Internal Server Error**: Server error.
```
Tokens:
Raw