REST API Reference for Launch Cloud Service

Get a lifecycle configuration

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/{id}

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Query Parameters

fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : LifecycleConfigurationOracle

Type: object

Title: LifecycleConfigurationOracle

The Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.

Show Source

@baseType: string

Immediate base (class) type of the lifecycle configurationn
@schemaLocation: string

A link to the schema describing this lifecycle configuration
@type: string

Class type of the lifecycle configuration
applicationName: string

name of the external application
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
description: string

A string. A narrative that explains in detail what the lifecycle configuration is.
externalId: string

id of the external application
href: string

A string. Reference of the lifecycle configuration.
id: string

Maximum Length: 100

A string. Unique identifier of the lifecycle configurations.
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the lifecycle configuration.
lastUpdatedBy: string

name of the person who updated item
lifecycleState: array lifecycleState
lifecycleStatus: string

Allowed Values: [ "ACTIVE", "PENDING", "INACTIVE" ]

A string. Used to indicate the current lifecycle status of the lifecycle configuration.
name(required): string

A string. Name of the lifecycle configuration.
version: string

A string. lifecycle configuration version.
versionState: number

Version state of the Life cycle configuration

{
    "title":"LifecycleConfigurationOracle",
    "type":"object",
    "description":"The Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"100",
            "description":"A string. Unique identifier of the lifecycle configurations."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the lifecycle configuration."
        },
        "version":{
            "type":"string",
            "description":"A string. lifecycle configuration version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the lifecycle configuration."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the lifecycle configuration is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the lifecycle configuration.",
            "enum":[
                "ACTIVE",
                "PENDING",
                "INACTIVE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"Class type of the lifecycle configuration"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the lifecycle configurationn"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this lifecycle configuration"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the lifecycle configuration."
        },
        "lifecycleState":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LifecycleStateOracle"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Life cycle configuration"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : lifecycleState

Type: array

Show Source

Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LifecycleStateOracle"
    }
}

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

@baseType: string

base class type (immediate parent) of the CustProfSpecCharacteristic
@schemaLocation: string

hyperlink reference to the schema describing this characteristic
@type: string

the class type of this characteristic
description: string

A string. A narrative that explains in detail what the LifecycleState is.
destination: array destination
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.
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

{
    "title":"LifecycleStateOracle",
    "type":"object",
    "description":"A list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.",
    "properties":{
        "name":{
            "type":"string",
            "description":"A string. A word, term, or phrase by which this lifecycle state is known and distinguished from other lifecycle states."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the LifecycleState is."
        },
        "isEditable":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates that the project is editable in this state or not."
        },
        "isContentEditable":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates that the entity in the project is editable or not."
        },
        "isApprovalRequired":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates whether this state needs approval to move tro next state."
        },
        "isPublishable":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates whether publish is allowed in this state."
        },
        "isSharable":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates whether the entity can be shared with other projects in this state."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates whether the state is enabled or not ."
        },
        "stateOrder":{
            "type":"integer",
            "description":"The sequence number of the state that shows the transition"
        },
        "errorState":{
            "type":"string",
            "description":"A string. Indicates the state it will end  up during transition if error happens for automatic transition like approval or publish"
        },
        "userAction":{
            "type":"string",
            "description":"A string. The name of the action for user triggered  state transition"
        },
        "@type":{
            "type":"string",
            "description":"the class type of this characteristic"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the CustProfSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to the schema describing this characteristic"
        },
        "destination":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DestinationRefOracle"
            }
        }
    },
    "required":[
        "name",
        "stateOrder"
    ]
}

Nested Schema : destination

Type: array

Show Source

Array of: object DestinationRefOracle

Title: DestinationRefOracle

A list of destinations references associated with lifecycle state.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DestinationRefOracle"
    }
}

Nested Schema : DestinationRefOracle

Type: object

Title: DestinationRefOracle

A list of destinations references associated with lifecycle state.

Show Source

@baseType: string

base class type (immediate parent) of the DestinationRefOracle
@referredType: string

the class type of associated destination.
@schemaLocation: string

hyperlink reference to schema describing this object
@type: string

Class type of target destination References
href: string

A string. Reference of the target destination.
id(required): string

Unique identifier of the publish destination.
name(required): string

A string. Name of the target destination.

{
    "title":"DestinationRefOracle",
    "type":"object",
    "description":"A list of destinations references associated with lifecycle state.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the publish destination."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the target destination."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the target destination."
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of associated destination."
        },
        "@type":{
            "type":"string",
            "description":"Class type of target destination References"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the DestinationRefOracle"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "id",
        "name"
    ]
}

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: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to retrieve a lifecycle configuration by submitting a get request on the REST resource using cURL.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/lifecycleStatusManagement/DEFAULT_LC_STATUS_CONFIG_ID

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": "69",
	"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
	}
	]
}