| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | The connection types to provide to this configuration. | x | ||
Response Timeout | Number | The timeout for request to the remote service. | 1 | |
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | MINUTES | |
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | AUTO | |
Name | String | The identifier of this element used to reference it in other components | x | |
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers | Array of Default Header | |||
Query Parameters | Array of Default Query Param | |||
Connection Timeout | Number | The timeout for establishing connections to the remote service | 30 | |
Connection Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Connection Timeout | SECONDS | |
Use Persistent Connections | Boolean | If false, each connection will be closed after the first request is completed. | true | |
Max Connections | Number | The maximum number of outbound connections to keep open at the same time | -1 | |
Connection Idle Timeout | Number | A timeout for how long a connection can remain idle before it is closed | 30 | |
Connection Idle Timeout Unit | Enumeration, one of:
| A time unit that qualifies the connection Idle Timeout | SECONDS | |
Proxy Config | Reusable configuration element for outbound connections through a proxy | |||
Stream Response | Boolean | Whether or not received responses should be streamed | false | |
Response Buffer Size | Number | The space in bytes for the buffer where the HTTP response will be stored. | -1 | |
Base Uri | String | Parameter base URI, each instance/tenant gets its own | ||
Protocol | Enumeration, one of:
| Protocol to use for communication. Valid values are HTTP and HTTPS | HTTP | |
TLS Configuration | ||||
Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | |||
Consumer Key | String | The OAuth consumerKey as registered with the service provider | x | |
Consumer Secret | String | The OAuth consumerSecret as registered with the service provider | x | |
Authorization Url | String | The service provider’s authorization endpoint. URL |
| |
Access Token Url | String | The service provider’s accessToken endpoint. URL |
| |
Scopes | String | The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation | default openid email profile | |
Resource Owner Id | String | The resourceOwnerId which each component should use if it doesn’t reference otherwise. | ||
Before | String | The name of a flow to execute right before starting the OAuth dance | ||
After | String | The name of a flow to execute right after an accessToken has been received | ||
Listener Config | String | A reference to a <http:listener-config /> to use to create the listener that will catch the access token callback endpoint.. | x | |
Callback Path | String | The path of the access token callback endpoint. | x | |
Authorize Path | String | The path of the local http endpoint. which triggers the OAuth dance | x | |
External Callback Url | String | If the callback endpoint. is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback | ||
Object Store | String | A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers | Array of Default Header | |||
Query Parameters | Array of Default Query Param | |||
Connection Timeout | Number | The timeout for establishing connections to the remote service | 30 | |
Connection Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Connection Timeout | SECONDS | |
Use Persistent Connections | Boolean | If false, each connection will be closed after the first request is completed. | true | |
Max Connections | Number | The maximum number of outbound connections to keep open at the same time | -1 | |
Connection Idle Timeout | Number | A timeout for how long a connection can remain idle before it is closed | 30 | |
Connection Idle Timeout Unit | Enumeration, one of:
| A time unit that qualifies the connection Idle Timeout | SECONDS | |
Proxy Config | Reusable configuration element for outbound connections through a proxy | |||
Stream Response | Boolean | Whether or not received responses should be streamed | false | |
Response Buffer Size | Number | The space in bytes for the buffer where the HTTP response will be stored. | -1 | |
Base Uri | String | Parameter base URI, each instance/tenant gets its own | ||
Protocol | Enumeration, one of:
| Protocol to use for communication. Valid values are HTTP and HTTPS | HTTP | |
TLS Configuration | ||||
Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Batch Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request. | ||
Custom Fields Content | Any | the content to use | #[payload] | |
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Custom field gid | String | Globally unique identifier for the custom field. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Custom Fields Enum Options Content | Any | the content to use | #[payload] | |
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Custom field gid | String | Globally unique identifier for the custom field. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Custom Fields Enum Options Insert Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Organization Exports Content | Any | the content to use | #[payload] | |
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Portfolios Add Custom Field Setting Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Add Item Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Add Members Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Portfolios Remove Custom Field Setting Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Remove Item Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Remove Members Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Portfolios Add Custom Field Setting Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Add Followers Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Add Members Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Duplicate Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Project Statuses Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Portfolios Remove Custom Field Setting Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Remove Followers Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Remove Members Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Sections Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Sections Insert Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Section gid | String | The globally unique identifier for the section. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Sections Add Task Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tags Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Dependencies Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Dependents Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Followers Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Project Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Tag Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Attachment Request Content | Any | the content to use | #[payload] | |
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Duplicate Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Dependencies Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Add Dependents Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Remove Followers Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Remove Project Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Remove Tag Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Set Parent Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Stories Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Teams Content | Any | the content to use | #[payload] | |
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Teams Add User Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Teams Remove User Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Webhooks Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Workspaces Add User Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Workspaces Remove User Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Create Tags Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Attachment gid | String | Globally unique identifier for the attachment. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Custom field gid | String | Globally unique identifier for the custom field. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project status gid | String | The project status update to get. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Section gid | String | The globally unique identifier for the section. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Story gid | String | Globally unique identifier for the story. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Tag gid | String | Globally unique identifier for the tag. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Webhook gid | String | Globally unique identifier for the webhook. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Attachment gid | String | Globally unique identifier for the attachment. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Custom field gid | String | Globally unique identifier for the custom field. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
resource | String | A resource ID to subscribe to. The resource can be a task or project. | x | |
sync | String | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. NOTE: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Job gid | String | Globally unique identifier for the job. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Organization export gid | String | Globally unique identifier for the organization export. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
portfolio | String | The portfolio to filter results on. | ||
user | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
workspace | String | The workspace to filter results on. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio membership gid | String | Portfolio membership gid | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | The workspace or organization to filter portfolios on. | x | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
owner | String | The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own. | x | |
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
user | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project membership gid | String | Project membership gid | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project status gid | String | The project status update to get. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | The workspace or organization to filter projects on. | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
team | String | The team to filter projects on. | ||
archived | Boolean | Only return projects whose | false | |
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
user | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Section gid | String | The globally unique identifier for the section. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Section gid | String | The globally unique identifier for the section. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Story gid | String | Globally unique identifier for the story. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | The workspace to filter tags on. | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Tag gid | String | Globally unique identifier for the tag. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Tag gid | String | Globally unique identifier for the tag. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
assignee | String | The assignee to filter tasks on. NOTE: If you specify | ||
project | String | The project to filter tasks on. | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
section | String | The section to filter tasks on. NOTE: Currently, this is only supported in board views. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | The workspace to filter tasks on. NOTE: If you specify | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Modified since | String | Only return tasks that have been modified since the given time. NOTE: A task is considered 'modified' if any of its properties change, or associations between it and other objects are modified (, for example a task being added to a project). A task is not considered modified just because another object it is associated with (, for example a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories. | ||
Completed since | String | Only return tasks that are either incomplete or that have been completed since this time. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | Globally unique identifier for the workspace. This parameter must be used with the user parameter. | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
team | String | Globally unique identifier for the team. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
user | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. This parameter must be used with the workspace parameter. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team membership gid | String | Team membership gid | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
archived | Boolean | Only return projects whose | false | |
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Team gid | String | Globally unique identifier for the team. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User task list gid | String | Globally unique identifier for the user task list. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User task list gid | String | Globally unique identifier for the user task list. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Completed since | String | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | The workspace or organization ID to filter users on. | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User gid | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User gid | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Resource type | Enumeration, one of:
| The resource type of favorites to be returned. | PROJECT | |
workspace | String | The workspace in which to get favorites. | x | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User gid | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | Globally unique identifier for the workspace. | x | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User gid | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | x | |
organization | String | The workspace or organization to filter teams on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User gid | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
workspace | String | The workspace in which to get the user task list. | x | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
User gid | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
workspace | String | The workspace to query for webhooks in. | x | |
resource | String | Only return webhooks for the given resource. | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Webhook gid | String | Globally unique identifier for the webhook. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace membership gid | String | Workspace membership gid | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
archived | Boolean | Only return projects whose | false | |
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Created on before | String | ISO 8601 date string | ||
Created by any | String | Comma-separated list of user identifiers | ||
Due on after | String | ISO 8601 date string | ||
Tags all | String | Comma-separated list of tag IDs | ||
Liked by not | String | Comma-separated list of user identifiers | ||
Modified on | String | ISO 8601 date string or | ||
Is blocked | Boolean | Filter to tasks with incomplete dependencies | false | |
Liked by any | String | Comma-separated list of user identifiers | ||
Modified on after | String | ISO 8601 date string | ||
Is blocking | Boolean | Filter to incomplete tasks with dependents | false | |
Start on | String | ISO 8601 date string or | ||
Teams any | String | Comma-separated list of team IDs | ||
Opt pretty | Boolean | Provides 'pretty' output. Provides the response in a 'pretty' format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Tags any | String | Comma-separated list of tag IDs | ||
Portfolios any | String | Comma-separated list of portfolio IDs | ||
Followers not | String | Comma-separated list of user identifiers | ||
Due at after | String | ISO 8601 datetime string | ||
Sort ascending | Boolean | Default | false | |
Projects not | String | Comma-separated list of project IDs | ||
Is subtask | Boolean | Filter to subtasks | false | |
text | String | Performs full-text search on both task name and description | ||
Tags not | String | Comma-separated list of tag IDs | ||
Created at before | String | ISO 8601 datetime string | ||
Start on after | String | ISO 8601 date string | ||
Completed on | String | ISO 8601 date string or | ||
Created at after | String | ISO 8601 datetime string | ||
Sections not | String | Comma-separated list of section or column IDs | ||
completed | Boolean | Filter to completed tasks | false | |
Modified at after | String | ISO 8601 datetime string | ||
Start on before | String | ISO 8601 date string | ||
Followers any | String | Comma-separated list of user identifiers | ||
Modified at before | String | ISO 8601 datetime string | ||
Sort by | Enumeration, one of:
| One of | MODIFIED_AT | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. | ||
Assigned by any | String | Comma-separated list of user identifiers | ||
Assigned by not | String | Comma-separated list of user identifiers | ||
Sections any | String | Comma-separated list of section or column IDs | ||
Created on after | String | ISO 8601 date string | ||
Due at before | String | ISO 8601 datetime string | ||
Due on | String | ISO 8601 date string or | ||
Commented on by not | String | Comma-separated list of user identifiers | ||
Created on | String | ISO 8601 date string or | ||
Completed at before | String | ISO 8601 datetime string | ||
Assignee any | String | Comma-separated list of user identifiers | ||
Modified on before | String | ISO 8601 date string | ||
Assignee not | String | Comma-separated list of user identifiers | ||
Projects all | String | Comma-separated list of project IDs | ||
Completed on after | String | ISO 8601 date string | ||
Projects any | String | Comma-separated list of project IDs | ||
Sections all | String | Comma-separated list of section or column IDs | ||
Completed at after | String | ISO 8601 datetime string | ||
Has attachment | Boolean | Filter to tasks with attachments | false | |
Completed on before | String | ISO 8601 date string | ||
Created by not | String | Comma-separated list of user identifiers | ||
Commented on by any | String | Comma-separated list of user identifiers | ||
Due on before | String | ISO 8601 date string | ||
Resource subtype | Enumeration, one of:
| Filters results by the task’s resource_subtype | MILESTONE | |
Config Ref | ConfigurationProvider | The name of the configuration to be used to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | The name of a variable on which the operation’s output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
count | Number | The number of results to return. The default is 20 if this parameter is omitted, with a minimum of 1 and a maximum of 100. If there are fewer results found than requested, all will be returned. | ||
Resource type | Enumeration, one of:
| The type of values the typeahead should return. You can choose from one of the following: | USER | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
query | String | The string to use to search for relevant objects. If an empty string is passed in, the API will currently return an empty result set. | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
type | Enumeration, one of:
| Deprecated: new integrations should prefer the resource_type field. | USER | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
user | String | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Resource Owner Id | String | The ID of the resource owner which access should be invalidated | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Custom field gid | String | Globally unique identifier for the custom field. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Custom Fields Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Enum option gid | String | Globally unique identifier for the enum option. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Custom Fields Enum Options Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Portfolio gid | String | Globally unique identifier for the portfolio. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Portfolios Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Project gid | String | Globally unique identifier for the project. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Projects Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Section gid | String | The globally unique identifier for the section. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Sections Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Story gid | String | Globally unique identifier for the story. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Stories Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Tag gid | String | Globally unique identifier for the tag. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
limit | Number | Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
offset | String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | ||
output Mime Type | String | The mime type of the payload that this operation outputs. | ||
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | #[null] | ||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Task gid | String | The task to operate on. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Tasks Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Workspace gid | String | Globally unique identifier for the workspace or organization. | x | |
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Opt fields | Array of String | Defines fields to return. Some requests return compact representations of objects to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The ID of included objects will always be returned, regardless of the field options. | ||
Workspaces Content | Any | the content to use | #[payload] | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Custom Query Parameters | Object | |||
Custom Headers | Object | |||
Response Timeout | Number | The timeout for request to the remote service. | ||
Response Timeout Unit | Enumeration, one of:
| A time unit that qualifies the Response Timeout} | ||
Streaming Type | Enumeration, one of:
| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. | ||
Target Variable | String | Name of the variable that stores operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Modified since | DateTime | Only return tasks that have been modified since the given time. NOTE: A task is considered 'modified' if any of its properties change, or associations between it and other objects are modified (, for example a task being added to a project). A task is not considered modified just because another object it is associated with (, for example a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories. | x | |
Assignee | String | The assignee to filter tasks on. Note: If you specify | ||
Workspace | String | The workspace to filter tasks on. Note: If you specify | ||
Project | String | The project to filter tasks on. | ||
Section | String | The section to filter tasks on. Note: Currently, this is only supported in board views. | ||
Opt pretty | Boolean | Provides 'pretty'output. Provides the response in a 'pretty'format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | false | |
Config Ref | ConfigurationProvider | The name of the configuration to use to execute this component | ||
Primary Node Only | Boolean | Whether this source should only be executed on the primary node when running in a cluster | ||
Scheduling Strategy | scheduling-strategy | Configures the scheduler that triggers the polling | x | |
Streaming Strategy |
| Configure if repeatable streams should be used and their behavior | ||
Redelivery Policy | Defines a policy for processing the redelivery of the same message | |||
Reconnection Strategy | A retry strategy in case of connectivity errors |
Type | Any |
Attributes Type |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Key | String | x | ||
Value | String | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Key | String | x | ||
Value | String | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host | String | x | ||
Port | Number | x | ||
Username | String | |||
Password | String | |||
Non Proxy Hosts | String |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols | String | A comma-separated list of protocols enabled for this context. | ||
Enabled Cipher Suites | String | A comma-separated list of cipher suites enabled for this context. | ||
Trust Store | ||||
Key Store | ||||
Revocation Check |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. | ||
Password | String | The password used to protect the trust store. | ||
Type | String | The type of store used. | ||
Algorithm | String | The algorithm used by the trust store. | ||
Insecure | Boolean | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. | ||
Type | String | The type of store used. | ||
Alias | String | When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. | ||
Key Password | String | The password used to protect the private key. | ||
Password | String | The password used to protect the key store. | ||
Algorithm | String | The algorithm used by the key store. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities | Boolean | Only verify the last element of the certificate chain. | ||
Prefer Crls | Boolean | Try CRL instead of OCSP first. | ||
No Fallback | Boolean | Do not use the secondary checking method (the one not selected before). | ||
Soft Fail | Boolean | Avoid verification failure when the revocation server can not be reached or is busy. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url | String | The URL of the OCSP responder. | ||
Cert Alias | String | Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | The path to the CRL file. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment | Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | ||
Reconnection Strategy | The reconnection strategy to use. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often in milliseconds to reconnect | ||
Blocking | Boolean | If false, the reconnection strategy will run in a separate, non-blocking thread | ||
Count | Number | How many reconnection attempts to make. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often in milliseconds to reconnect | ||
Blocking | Boolean | If false, the reconnection strategy will run in a separate, non-blocking thread |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time | Number | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration | ||
Time Unit | Enumeration, one of:
| A time unit that qualifies the maxIdleTime attribute |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code | Number | x | ||
Headers | Object | x | ||
Reason Phrase | String | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. | ||
Buffer Size Increment | Number | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. | ||
Max Buffer Size | Number | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. | ||
Buffer Unit | Enumeration, one of:
| The unit in which all these attributes are expressed |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size | Number | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. | ||
Buffer Unit | Enumeration, one of:
| The unit in which maxInMemorySize is expressed |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Redelivery Count | Number | The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message | ||
Message Digest Algorithm | String | The secure hashing algorithm to use. If not set, the default is SHA-256. | ||
Message Identifier | Defines which strategy is used to identify the messages. | |||
Object Store | ObjectStore | The object store where the redelivery counter for each message is stored. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Use Secure Hash | Boolean | Whether to use a secure hash algorithm to identify a redelivered message. | ||
Id Expression | String | Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. | ||
Buffer Size Increment | Number | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. | ||
Max Buffer Size | Number | The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects | Number | The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | ||
Buffer Unit | Enumeration, one of:
| The unit in which maxInMemorySize is expressed |