REST API Reference for Launch Cloud Service

Create or update an array of market segments

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/marketSegments

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 50

Show Source

Array of: object MarketSegmentOracle

Title: MarketSegmentOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MarketSegmentOracle"
    },
    "minItems":1,
    "maxItems":50
}

Nested Schema : MarketSegmentOracle

Type: object

Title: MarketSegmentOracle

Show Source

@baseType: string

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

A link to the schema describing this object
@type(required): string

Indicates the type of resource.
applicationName: string

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

Date and time of the market segment creation.
createdBy: string

name of the person who created the market segment.
description: string

Description of market segment.
externalId: string

id of the external application
href: string

Hypertext Reference of the market segment.
id: string

Maximum Length: 30

Unique identifier of the market segment.
lastUpdate: string (date-time)

Latest update date of market segment.
lastUpdatedBy: string

name of the person who updated the market segment.
lifecycleStatus: string

Lifecycle status of market segment.
name(required): string

Name of market segment.
project: object ProjectRef

Title: ProjectRef

Project Reference
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Market segment version
versionState: number

Version state of the market segment.

{
    "title":"MarketSegmentOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the market segment."
        },
        "name":{
            "type":"string",
            "description":"Name of market segment."
        },
        "description":{
            "type":"string",
            "description":"Description of market segment."
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the market segment."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of market segment."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Lifecycle status of market segment."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Market segment version"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the market segment creation."
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created the market segment."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated the market segment."
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the market segment."
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Your request is successful and the resources have been created or updated.

Root Schema : schema

Type: array

Show Source

Array of: object MarketSegmentOracle

Title: MarketSegmentOracle

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

Nested Schema : MarketSegmentOracle

Type: object

Title: MarketSegmentOracle

Show Source

@baseType: string

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

A link to the schema describing this object
@type(required): string

Indicates the type of resource.
applicationName: string

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

Date and time of the market segment creation.
createdBy: string

name of the person who created the market segment.
description: string

Description of market segment.
externalId: string

id of the external application
href: string

Hypertext Reference of the market segment.
id: string

Maximum Length: 30

Unique identifier of the market segment.
lastUpdate: string (date-time)

Latest update date of market segment.
lastUpdatedBy: string

name of the person who updated the market segment.
lifecycleStatus: string

Lifecycle status of market segment.
name(required): string

Name of market segment.
project: object ProjectRef

Title: ProjectRef

Project Reference
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Market segment version
versionState: number

Version state of the market segment.

{
    "title":"MarketSegmentOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the market segment."
        },
        "name":{
            "type":"string",
            "description":"Name of market segment."
        },
        "description":{
            "type":"string",
            "description":"Description of market segment."
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the market segment."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of market segment."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Lifecycle status of market segment."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Market segment version"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the market segment creation."
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created the market segment."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated the market segment."
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the market segment."
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

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

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/Error"
            },
            {
                "$ref":"#/components/schemas/BulkError"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "Error":"#/components/schemas/Error",
                "BulkError":"#/components/schemas/BulkError"
            }
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "$ref":"#/components/schemas/BulkError"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error",
            "BulkError":"#/components/schemas/BulkError"
        }
    }
}

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 create or update an array of market segments by submitting a put request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/marketSegment -H 'Content-Type: application/json' -D @put_marketsegment.json | json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

[
 {
  "id": "MS-3109730862",
  "name": "ARPU",
  "description": "ARPU Segment",
  "@type": "MarketSegmentOracle",
  "validFor": {
    "startDateTime": "2025-09-12T00:00:00.000Z",
    "endDateTime": "2025-10-09T00:00:00.000Z"
  },
  "project": {
    "id": "P-2341675923-1758270057151",
    "name": "Retire Init3",
    "@type": "ProjectRef",
    "@referredType": "ProjectOracle"
  },
  "version": "1.0",
  "lifecycleStatus": "In design"
  
},
{
  "id": "MS-3109730863",
  "name": "AMPU",
  "description": "AMPU Segment",
  "@type": "MarketSegmentOracle",
  "validFor": {
    "startDateTime": "2025-09-12T00:00:00.000Z",
    "endDateTime": "2025-10-09T00:00:00.000Z"
  },
  "project": {
    "id": "P-2341675923-1758270057151",
    "name": "Retire Init3",
    "@type": "ProjectRef",
    "@referredType": "ProjectOracle"
  },
  "version": "1.0",
  "lifecycleStatus": "In design"
  
 }
]

Example of Response Body

The following shows an example of the response body in JSON format.

[
  
{
    "id": "MS-3109730862",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/marketSegment/MS-3109730862",
    "name": "ARPU",
    "description": "ARPU Segment",
    "lifecycleStatus": "In design",
    "lastUpdate": "2025-10-23T08:09:44.080Z",
    "validFor": {
        "startDateTime": "2025-09-12T00:00:00.000Z",
        "endDateTime": "2025-10-09T00:00:00.000Z"
    },
    "version": "1.0",
    "@type": "MarketSegmentOracle",
    "project": {
        "id": "P-2341675923-1758270057151",
        "name": "Retire Init3",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-2341675923-1758270057151",
        "version": "1.0",
        "@referredType": "ProjectOracle",
        "@type": "ProjectRef"
    },
    "lastUpdatedBy": "booth",
    "created": "2025-10-23T08:09:44.000Z",
    "createdBy": "booth",
    "versionState": 0
},
{
    "id": "MS-3109730863",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/marketSegment/MS-3109730863",
    "name": "AMPU",
    "description": "AMPU Segment",
    "lifecycleStatus": "In design",
    "lastUpdate": "2025-10-23T08:09:44.080Z",
    "validFor": {
        "startDateTime": "2025-09-12T00:00:00.000Z",
        "endDateTime": "2025-10-09T00:00:00.000Z"
    },
    "version": "1.0",
    "@type": "MarketSegmentOracle",
    "project": {
        "id": "P-2341675923-1758270057151",
        "name": "Retire Init3",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-2341675923-1758270057151",
        "version": "1.0",
        "@referredType": "ProjectOracle",
        "@type": "ProjectRef"
    },
    "lastUpdatedBy": "booth",
    "created": "2025-10-23T08:09:44.000Z",
    "createdBy": "booth",
    "versionState": 0
}