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
Supported Media Types
Request Body - application/json ()
Root Schema : LifecycleConfigurationOracle
Type: object
Title: LifecycleConfigurationOracle
The Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.
Show Source
Nested Schema : lifecycleState
Type: array
A list of lifecycle states associated with the lifecycle configuration.
Show Source
  • LifecycleStateOracle
    Title: LifecycleStateOracle
    A 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: object
Title: LifecycleStateOracle
A list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.
Show Source
Nested Schema : destination
Type: array
A list of destinations associated with the lifecycle state.
Show Source
Nested Schema : DestinationRefOracle
Type: object
Title: DestinationRefOracle
A list of destinations references associated with lifecycle state.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The lifecycle configuration was created or updated successfully.
Body ()
Root Schema : LifecycleConfigurationOracle
Type: object
Title: LifecycleConfigurationOracle
The Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.
Show Source
Nested Schema : lifecycleState
Type: array
A list of lifecycle states associated with the lifecycle configuration.
Show Source
  • LifecycleStateOracle
    Title: LifecycleStateOracle
    A 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: object
Title: LifecycleStateOracle
A list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.
Show Source
Nested Schema : destination
Type: array
A list of destinations associated with the lifecycle state.
Show Source
Nested Schema : DestinationRefOracle
Type: object
Title: DestinationRefOracle
A list of destinations references associated with lifecycle state.
Show Source

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.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source
Back to Top

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=ACTIVE

Example 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
        }
    ]
}
Back to Top