1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Projects

Update a project

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/{id}

Updates the project that matches the specified ID using the supplied request payload.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : ProjectOracle
Title: ProjectOracle
Match All
Show Source
  • Project
    Title: Project
    Discriminator: { "propertyName":"@type", "mapping":{ "Project":"#/components/schemas/Project", "ProjectOracle":"#/components/schemas/ProjectOracle" } }
    A detailed description of the project.
  • type
Nested Schema : Project
Type: object
Title: Project
Discriminator: @type

Discriminator Values

A detailed description of the project.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : approvalHistory
Type: array
A list of approval histories associated with the project.
Show Source
Nested Schema : approver
Type: array
A list of approvers associated with the project.
Show Source
Nested Schema : attachment
Type: array
A list of attachments associated with the project.
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentOracle":"#/components/schemas/AttachmentOracle", "AttachmentRef":"#/components/schemas/AttachmentRef" } }
Nested Schema : LifecycleConfigurationRef
Type: object
Title: LifecycleConfigurationRef
The lifecycle configuration reference resource.
Show Source
Nested Schema : notification
Type: array
A list of notifications associated with the project.
Show Source
Nested Schema : projectHistory
Type: array
A list of project histories associated with the project.
Show Source
Nested Schema : projectItems
Type: array
A list of project items associated with the project.
Show Source
  • ProjectItemRef
    Title: ProjectItemRef
    The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Nested Schema : PublishJobRef
Type: object
Title: PublishJobRef
The publish Job reference. A Job describes the details of the publishing state.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : team
Type: array
A list of teams associated with the project.
Show Source
  • TeamOracle
    Title: TeamOracle
    The team details of an initiative. Includes the name, role and email address of team member which is part of initiative.
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid.
Show Source
Nested Schema : ApprovalHistory
Type: object
Title: ApprovalHistory
The approval history resource.
Show Source
Nested Schema : ApproverRef
Type: object
Title: ApproverRef
The approver reference resource.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Nested Schema : NotificationOracle
Type: object
Title: NotificationOracle
The notification details of an initiative. Includes the state.
Show Source
Nested Schema : subscriber
Type: array
A list of subscribers associated with the notification.
Show Source
Nested Schema : SubscriberOracle
Type: object
Title: SubscriberOracle
The subscriber resource.
Show Source
Nested Schema : ProjectHistory
Type: object
Title: ProjectHistory
The project history resource.
Show Source
Nested Schema : ProjectItemRef
Type: object
Title: ProjectItemRef
The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Show Source
  • The TMF base type of the target instance when needed for disambiguation.
  • The actual type of the target instance when needed for disambiguation.
  • The name of the application associated with the project item reference.
  • The name of the commercial associated with the project item reference.
  • context
    A list of contexts associated with the project item reference.
  • The name of the person who created item.
  • The end date and time for the project item reference.
  • Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]
    The type or classification of the project item reference. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE.
  • The hyperlink reference to the project item reference.
  • The ID of the project item reference.
  • Whether the project item reference is bundle.
  • The lifecycleStatus of the related entity.
  • The name of the project item reference.
  • Allowed Values: [ "RECURRING", "ONE_TIME", "USAGE", "ALTERATION", "ALLOWANCE", "OVERAGE", "PENALTY", "ONE_TIME_PRICE_PLAN", "RECURRING_PRICE_PLAN", "USAGE_PRICE_PLAN", "ALTERATION_PRICE_PLAN", "OVERAGE_PRICE_PLAN", "COUNTER" ]
    The type or classification of the project item reference.
  • Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER", "OTHERS" ]
    The type or classification of the project item reference. Valid values are PACKAGE, COMMERCIAL_BUNDLE, SERVICE_BUNDLE, SERVICE, DEVICE, ACCESSORY, CHOICE, AGGREGATION, SYSTEM_OFFER, and OTHERS.
  • Allowed Values: [ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP" ]
    The type or classification of the project item reference. Valid values are DEVICE_SPEC, BUSINESS_CONFIG, TRADE_IN, CHARGING_TERM, SUSPENSION_TERM, RETURN_CHECKLIST, ENTITY_PROFILE, RENEWAL_TERM, FINANCE_PLAN, and ZONE_VALUE_MAP.
  • Allowed Values: [ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]
    The type or classification of the project item reference. Valid values are AWARD, DISCOUNT, TRADE_IN, and CROSS_PRODUCT_DISCOUNT.
  • Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
    The type or classification of the project item reference. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT.
  • The start date and time for the project item reference.
  • The version of the object.
Nested Schema : context
Type: array
A list of contexts associated with the project item reference.
Show Source
Nested Schema : ProjectItemContextsOracle
Type: object
Title: ProjectItemContextsOracle
The project item context objects which holds the KPI parameters.
Show Source
Nested Schema : params
Type: array
A list of params associated with the project item context.
Show Source
Nested Schema : ProjectItemContextParamsOracle
Type: object
Title: ProjectItemContextParamsOracle
The project item context KPI parameters.
Show Source
Nested Schema : TeamOracle
Type: object
Title: TeamOracle
The team details of an initiative. Includes the name, role and email address of team member which is part of initiative.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The project was updated successfully.
Body ()
Root Schema : ProjectOracle
Title: ProjectOracle
Match All
Show Source
  • Project
    Title: Project
    Discriminator: { "propertyName":"@type", "mapping":{ "Project":"#/components/schemas/Project", "ProjectOracle":"#/components/schemas/ProjectOracle" } }
    A detailed description of the project.
  • type
Nested Schema : Project
Type: object
Title: Project
Discriminator: @type

Discriminator Values

A detailed description of the project.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : approvalHistory
Type: array
A list of approval histories associated with the project.
Show Source
Nested Schema : approver
Type: array
A list of approvers associated with the project.
Show Source
Nested Schema : attachment
Type: array
A list of attachments associated with the project.
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentOracle":"#/components/schemas/AttachmentOracle", "AttachmentRef":"#/components/schemas/AttachmentRef" } }
Nested Schema : LifecycleConfigurationRef
Type: object
Title: LifecycleConfigurationRef
The lifecycle configuration reference resource.
Show Source
Nested Schema : notification
Type: array
A list of notifications associated with the project.
Show Source
Nested Schema : projectHistory
Type: array
A list of project histories associated with the project.
Show Source
Nested Schema : projectItems
Type: array
A list of project items associated with the project.
Show Source
  • ProjectItemRef
    Title: ProjectItemRef
    The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Nested Schema : PublishJobRef
Type: object
Title: PublishJobRef
The publish Job reference. A Job describes the details of the publishing state.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : team
Type: array
A list of teams associated with the project.
Show Source
  • TeamOracle
    Title: TeamOracle
    The team details of an initiative. Includes the name, role and email address of team member which is part of initiative.
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid.
Show Source
Nested Schema : ApprovalHistory
Type: object
Title: ApprovalHistory
The approval history resource.
Show Source
Nested Schema : ApproverRef
Type: object
Title: ApproverRef
The approver reference resource.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Nested Schema : NotificationOracle
Type: object
Title: NotificationOracle
The notification details of an initiative. Includes the state.
Show Source
Nested Schema : subscriber
Type: array
A list of subscribers associated with the notification.
Show Source
Nested Schema : SubscriberOracle
Type: object
Title: SubscriberOracle
The subscriber resource.
Show Source
Nested Schema : ProjectHistory
Type: object
Title: ProjectHistory
The project history resource.
Show Source
Nested Schema : ProjectItemRef
Type: object
Title: ProjectItemRef
The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Show Source
  • The TMF base type of the target instance when needed for disambiguation.
  • The actual type of the target instance when needed for disambiguation.
  • The name of the application associated with the project item reference.
  • The name of the commercial associated with the project item reference.
  • context
    A list of contexts associated with the project item reference.
  • The name of the person who created item.
  • The end date and time for the project item reference.
  • Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]
    The type or classification of the project item reference. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE.
  • The hyperlink reference to the project item reference.
  • The ID of the project item reference.
  • Whether the project item reference is bundle.
  • The lifecycleStatus of the related entity.
  • The name of the project item reference.
  • Allowed Values: [ "RECURRING", "ONE_TIME", "USAGE", "ALTERATION", "ALLOWANCE", "OVERAGE", "PENALTY", "ONE_TIME_PRICE_PLAN", "RECURRING_PRICE_PLAN", "USAGE_PRICE_PLAN", "ALTERATION_PRICE_PLAN", "OVERAGE_PRICE_PLAN", "COUNTER" ]
    The type or classification of the project item reference.
  • Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER", "OTHERS" ]
    The type or classification of the project item reference. Valid values are PACKAGE, COMMERCIAL_BUNDLE, SERVICE_BUNDLE, SERVICE, DEVICE, ACCESSORY, CHOICE, AGGREGATION, SYSTEM_OFFER, and OTHERS.
  • Allowed Values: [ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP" ]
    The type or classification of the project item reference. Valid values are DEVICE_SPEC, BUSINESS_CONFIG, TRADE_IN, CHARGING_TERM, SUSPENSION_TERM, RETURN_CHECKLIST, ENTITY_PROFILE, RENEWAL_TERM, FINANCE_PLAN, and ZONE_VALUE_MAP.
  • Allowed Values: [ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]
    The type or classification of the project item reference. Valid values are AWARD, DISCOUNT, TRADE_IN, and CROSS_PRODUCT_DISCOUNT.
  • Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
    The type or classification of the project item reference. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT.
  • The start date and time for the project item reference.
  • The version of the object.
Nested Schema : context
Type: array
A list of contexts associated with the project item reference.
Show Source
Nested Schema : ProjectItemContextsOracle
Type: object
Title: ProjectItemContextsOracle
The project item context objects which holds the KPI parameters.
Show Source
Nested Schema : params
Type: array
A list of params associated with the project item context.
Show Source
Nested Schema : ProjectItemContextParamsOracle
Type: object
Title: ProjectItemContextParamsOracle
The project item context KPI parameters.
Show Source
Nested Schema : TeamOracle
Type: object
Title: TeamOracle
The team details of an initiative. Includes the name, role and email address of team member which is part of initiative.
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

403 Response

You don't have authorization to perform this request.
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

409 Response

The request can't be completed due to a conflict with the current state of the resource.
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 a project by submitting a Patch request on the REST resource using cURL.

cURL Command

curl -u username:password -X PATCH \ 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DocProject12 -H 'Content-Type: application/json' -D @update_project.json | json_pp

Example of Request Body

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

{
    "description" : "This project includes all our offerings, specifications and catalogs for Spring Project",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "lastUpdate": "2025-02-17T11:03:33.029Z",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T11:03:33.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "id": "SpringProject",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/SpringProject",
    "name": "SpringProject",
    "description" : "This project includes all our offerings, specifications and catalogs for Spring Project",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
    "@type": "ProjectOracle",
    "version": "1.0",
    "action": "CREATE_OBJECT",
    "lifecycleStatus": "In design",
	"teamEnabled": true,
    "lifecycleConfiguration": {
        "id": "DEFAULT_LC_STATUS_CONFIG_ID",
        "name": "Default Lifecycle Status Configuration",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/DEFAULT_LC_STATUS_CONFIG_ID",
        "version": "1.0",
        "@referredType": "LifecycleConfigurationOracle"
    },
	"team": [
            {
                "id": "andre.pirlo",
                "name": "Andre Pirlo",
                "emailAddress": "andre@example.com",
                "roleCode": "Communications Catalog Product Manager",
                "partyNumber": "CDRM_993045",
                "isPrimary": false
            },
            {
                "id": "CDRM_980035",
                "name": "John",
                "emailAddress": "john@example.com",
                "roleCode": "Communications Catalog Administrator",
                "isPrimary": true
            }
    ],
    "notification": [
        {
            "@type": "NotificationOracle",
            "state": "Design complete",
            "subscriber": [
                {
                    "id": "MHoope",
                    "name": "Matt Hooper",
                    "@type": "SubscriberOracle",
                    "emailAddress": "matt@example.com",
                    "roleCode": "Sales Administrator",
                    "partyNumber": "100010037456865"
                }
            ]
        },
        {
            "@type": "NotificationOracle",
            "state": "In test",
            "subscriber": [
                {
                    "id": "Mary.Steinberg",
                    "name": "Mary Steinberg",
                    "@type": "SubscriberOracle",
                    "emailAddress": "Mary_Steinberg_grp@example.com",
                    "roleCode": "Contract Administrator",
                    "partyNumber": "CDRM_68858"
                }
            ]
        }
    ],
    "attachment": [
        {
            "url": "/project/SpringProject/attachment/attachment.jpg",
            "id": "ID9LeK5xSmQUSrv0ErdPHXIA",
            "@type": "AttachmentOracle",
            "mimeType": "image/jpeg",
            "name": "attachment.jpg"
        }
    ]
}
Back to Top