Create or update a lifecycle configuration
put
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/{id}
Creates or updates the lifecycle configuration with the specified ID.
Request
Path Parameters
-
id(required): string
The ID of the resource item.
Supported Media Types
- application/json
Root Schema : LifecycleConfigurationOracle
Type:
objectTitle:
LifecycleConfigurationOracleThe Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.
Show Source
-
@baseType: string
The base type of the lifecycle configuration.
-
@schemaLocation: string
The URI of the schema that defines the lifecycle configuration.
-
@type(required): string
The class type of the lifecycle configuration.
-
applicationName: string
The name of the application associated with the lifecycle configuration.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
description: string
A string. A narrative that explains in detail what the lifecycle configuration is.
-
externalId: string
The ID of the external associated with the lifecycle configuration.
-
href: string
A string. Reference of the lifecycle configuration.
-
id: string
Maximum Length:
100The ID of the lifecycle configuration. -
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the lifecycle configuration.
-
lastUpdatedBy: string
The name of the person who updated item.
-
lifecycleState: array
lifecycleState
A list of lifecycle states associated with the lifecycle configuration.
-
lifecycleStatus: string
Allowed Values:
[ "ACTIVE", "PENDING", "INACTIVE" ]The current lifecycle status of the lifecycle configuration. -
name(required): string
A string. Name of the lifecycle configuration.
-
version: string
The lifecycle configuration version.
-
versionState: number
The version state of the Life cycle configuration.
Nested Schema : lifecycleState
Type:
arrayA list of lifecycle states associated with the lifecycle configuration.
Show Source
-
Array of:
object LifecycleStateOracle
Title:
LifecycleStateOracleA list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.
Nested Schema : LifecycleStateOracle
Type:
objectTitle:
LifecycleStateOracleA list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.
Show Source
-
@baseType: string
The base type of the lifecycle state.
-
@schemaLocation: string
The URI of the schema that defines the lifecycle state.
-
@type(required): string
The class type of the lifecycle state.
-
description: string
A string. A narrative that explains in detail what the LifecycleState is.
-
destination: array
destination
A list of destinations associated with the lifecycle state.
-
errorState: string
A string. Indicates the state it will end up during transition if error happens for automatic transition like approval or publish.
-
isApprovalRequired: boolean
A boolean. If true, the Boolean indicates whether this state needs approval to move tro next state.
-
isContentEditable: boolean
A boolean. If true, the Boolean indicates that the entity in the project is editable or not.
-
isEditable: boolean
A boolean. If true, the Boolean indicates that the project is editable in this state or not.
-
isEnabled: boolean
A boolean. If true, the Boolean indicates whether the state is enabled or not.
-
isPublishable: boolean
A boolean. If true, the Boolean indicates whether publish is allowed in this state.
-
isSensitive: boolean
Whether the lifecycle state is sensitive.
-
isSharable: boolean
A boolean. If true, the Boolean indicates whether the entity can be shared with other projects in this state.
-
name(required): string
A string. A word, term, or phrase by which this lifecycle state is known and distinguished from other lifecycle states.
-
stateOrder(required): integer
The sequence number of the state that shows the transition.
-
userAction: string
A string. The name of the action for user triggered state transition.
Nested Schema : destination
Type:
arrayA list of destinations associated with the lifecycle state.
Show Source
-
Array of:
object DestinationRefOracle
Title:
DestinationRefOracleA list of destinations references associated with lifecycle state.
Nested Schema : DestinationRefOracle
Type:
objectTitle:
DestinationRefOracleA list of destinations references associated with lifecycle state.
Show Source
-
@baseType: string
The base type of the destination reference.
-
@referredType: string
The type of the referred destination reference.
-
@schemaLocation: string
The URI of the schema that defines the destination reference.
-
@type: string
The class type of the destination reference.
-
href: string
A string. Reference of the target destination.
-
id(required): string
The ID of the destination reference.
-
name(required): string
A string. Name of the target destination.
Response
Supported Media Types
- application/json
200 Response
The lifecycle configuration was created or updated successfully.
Root Schema : LifecycleConfigurationOracle
Type:
objectTitle:
LifecycleConfigurationOracleThe Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.
Show Source
-
@baseType: string
The base type of the lifecycle configuration.
-
@schemaLocation: string
The URI of the schema that defines the lifecycle configuration.
-
@type(required): string
The class type of the lifecycle configuration.
-
applicationName: string
The name of the application associated with the lifecycle configuration.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
description: string
A string. A narrative that explains in detail what the lifecycle configuration is.
-
externalId: string
The ID of the external associated with the lifecycle configuration.
-
href: string
A string. Reference of the lifecycle configuration.
-
id: string
Maximum Length:
100The ID of the lifecycle configuration. -
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the lifecycle configuration.
-
lastUpdatedBy: string
The name of the person who updated item.
-
lifecycleState: array
lifecycleState
A list of lifecycle states associated with the lifecycle configuration.
-
lifecycleStatus: string
Allowed Values:
[ "ACTIVE", "PENDING", "INACTIVE" ]The current lifecycle status of the lifecycle configuration. -
name(required): string
A string. Name of the lifecycle configuration.
-
version: string
The lifecycle configuration version.
-
versionState: number
The version state of the Life cycle configuration.
Nested Schema : lifecycleState
Type:
arrayA list of lifecycle states associated with the lifecycle configuration.
Show Source
-
Array of:
object LifecycleStateOracle
Title:
LifecycleStateOracleA list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.
Nested Schema : LifecycleStateOracle
Type:
objectTitle:
LifecycleStateOracleA list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.
Show Source
-
@baseType: string
The base type of the lifecycle state.
-
@schemaLocation: string
The URI of the schema that defines the lifecycle state.
-
@type(required): string
The class type of the lifecycle state.
-
description: string
A string. A narrative that explains in detail what the LifecycleState is.
-
destination: array
destination
A list of destinations associated with the lifecycle state.
-
errorState: string
A string. Indicates the state it will end up during transition if error happens for automatic transition like approval or publish.
-
isApprovalRequired: boolean
A boolean. If true, the Boolean indicates whether this state needs approval to move tro next state.
-
isContentEditable: boolean
A boolean. If true, the Boolean indicates that the entity in the project is editable or not.
-
isEditable: boolean
A boolean. If true, the Boolean indicates that the project is editable in this state or not.
-
isEnabled: boolean
A boolean. If true, the Boolean indicates whether the state is enabled or not.
-
isPublishable: boolean
A boolean. If true, the Boolean indicates whether publish is allowed in this state.
-
isSensitive: boolean
Whether the lifecycle state is sensitive.
-
isSharable: boolean
A boolean. If true, the Boolean indicates whether the entity can be shared with other projects in this state.
-
name(required): string
A string. A word, term, or phrase by which this lifecycle state is known and distinguished from other lifecycle states.
-
stateOrder(required): integer
The sequence number of the state that shows the transition.
-
userAction: string
A string. The name of the action for user triggered state transition.
Nested Schema : destination
Type:
arrayA list of destinations associated with the lifecycle state.
Show Source
-
Array of:
object DestinationRefOracle
Title:
DestinationRefOracleA list of destinations references associated with lifecycle state.
Nested Schema : DestinationRefOracle
Type:
objectTitle:
DestinationRefOracleA list of destinations references associated with lifecycle state.
Show Source
-
@baseType: string
The base type of the destination reference.
-
@referredType: string
The type of the referred destination reference.
-
@schemaLocation: string
The URI of the schema that defines the destination reference.
-
@type: string
The class type of the destination reference.
-
href: string
A string. Reference of the target destination.
-
id(required): string
The ID of the destination reference.
-
name(required): string
A string. Name of the target destination.
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to update the details of a lifecyle configuration by submitting a post request on the REST resource using cURL.
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/lifecycleStatusManagement/DEFAULT_LC_STATUS_CONFIG_ID?version=64&toLifecycleStatus=ACTIVEExample of Request Header
The following shows an example of the request header.
{
"id": "DEFAULT_LC_STATUS_CONFIG_ID",
"name": "Default Lifecycle Status Configuration",
"description": "Default Lifecycle Status Configuration",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/DEFAULT_LC_STATUS_CONFIG_ID",
"version": "64",
"lifecycleStatus": "PENDING",
"created": "2020-11-03T17:21:00.000Z",
"createdBy": "booth",
"lastUpdate": "2020-11-03T17:21:02.000Z",
"lastUpdatedBy": "booth",
"@type": "LifecycleConfigurationOracle",
"@baseType": "LifecycleConfigurationOracle",
"lifecycleState": [
{
"name": "Active",
"description": "Active",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": true,
"stateOrder": 400,
"errorState": "Active",
"userAction": "Publish"
},
{
"name": "Awaiting obsolete",
"description": "Obsolete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 750
},
{
"name": "Awaiting retirement",
"description": "Obsolete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": true,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 210
},
{
"name": "Design complete",
"description": "Design complete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": true,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 100,
"errorState": "In design",
"userAction": "Approve"
},
{
"name": "In design",
"description": "In design",
"isEditable": true,
"isContentEditable": true,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 0,
"userAction": "Confirm"
},
{
"name": "In test",
"description": "In test",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 300,
"userAction": "Test Complete"
},
{
"name": "Launched",
"description": "Launched",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": true
"stateOrder": 500
},
{
"name": "Obsolete",
"description": "Obsolete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 800
},
{
"name": "Ready to publish",
"description": "Ready to publish",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 200,
"errorState": "Ready to publish",
"userAction": "Publish"
},
{
"name": "Rejected",
"description": "Rejected",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 700
},
{
"name": "Retired",
"description": "Retired",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 600
}
]
}Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"id": "DEFAULT_LC_STATUS_CONFIG_ID",
"name": "Default Lifecycle Status Configuration",
"description": "Default Lifecycle Status Configuration",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/DEFAULT_LC_STATUS_CONFIG_ID/DEFAULT_LC_STATUS_CONFIG_ID",
"version": "64",
"lifecycleStatus": "PENDING",
"created": "2021-02-23T10:30:18.000Z",
"createdBy": "booth",
"lastUpdate": "2021-02-23T10:30:18.001Z",
"lastUpdatedBy": "booth",
"@type": "LifecycleConfigurationOracle",
"@baseType": "LifecycleConfigurationOracle",
"lifecycleState": [
{
"name": "Active",
"description": "Active",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": true,
"stateOrder": 400,
"errorState": "Active",
"userAction": "Publish"
},
{
"name": "Awaiting obsolete",
"description": "Obsolete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 750
},
{
"name": "Awaiting retirement",
"description": "Obsolete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": true,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 210
},
{
"name": "Design complete",
"description": "Design complete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": true,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 100,
"errorState": "In design",
"userAction": "Approve"
},
{
"name": "In design",
"description": "In design",
"isEditable": true,
"isContentEditable": true,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 0,
"userAction": "Confirm"
},
{
"name": "In test",
"description": "In test",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 300,
"userAction": "Test Complete"
},
{
"name": "Launched",
"description": "Launched",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": true,
"stateOrder": 500
},
{
"name": "Obsolete",
"description": "Obsolete",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 800
},
{
"name": "Ready to publish",
"description": "Ready to publish",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": true,
"isSharable": false,
"stateOrder": 200,
"errorState": "Ready to publish",
"userAction": "Publish"
},
{
"name": "Rejected",
"description": "Rejected",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 700
},
{
"name": "Retired",
"description": "Retired",
"isEditable": false,
"isContentEditable": false,
"isUserDefined": false,
"isApprovalRequired": false,
"@type": "LifecycleStateOracle",
"@baseType": "LifecycleStateOracle",
"isPublishable": false,
"isSharable": false,
"stateOrder": 600
}
]
}