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

Get all projects

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project

This operation list or find Project entities

Request

Query Parameters
  • The description of the resource.
  • 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.
  • The unique identifier of the resource item.
  • The current lifecycle status of the resource.
  • The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
  • The name of the resource.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
  • The current version of the resource.
  • enrich objects with usedBy information

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ProjectOracle
Title: ProjectOracle
Is a detailed description of the project
Match All
Is a detailed description of the project
Is a detailed description of the project
Show Source
  • Project
    Title: Project
    Discriminator: { "propertyName":"@type", "mapping":{ "Project":"#/components/schemas/Project", "ProjectOracle":"#/components/schemas/ProjectOracle" } }
    Is a detailed description of the project
  • ProjectOracle-allOf[1]
Nested Schema : Project
Type: object
Title: Project
Discriminator: @type

Discriminator Values

Is a detailed description of the project
Show Source
Nested Schema : ProjectOracle-allOf[1]
Type: object
Show Source
Nested Schema : approvalHistory
Type: array
Show Source
Nested Schema : LifecycleConfigurationRef
Type: object
Title: LifecycleConfigurationRef
LifecycleConfiguration Reference
Show Source
Nested Schema : projectHistory
Type: array
Show Source
Nested Schema : projectItems
Type: array
Contains the list of Catalog Objects
Show Source
  • PublishJobRef
    Title: PublishJobRef
    Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..
Nested Schema : PublishJobRef
Type: object
Title: PublishJobRef
Publish Job reference. A Job describes the details of the publishing state
Show Source
Nested Schema : ApprovalHistory
Type: object
Title: ApprovalHistory
Show Source
Nested Schema : ProjectHistory
Type: object
Title: ProjectHistory
Show Source
Nested Schema : PublishJobRef
Type: object
Title: PublishJobRef
Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..
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.
  • context
  • Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]
    entitlememt type
  • Reference of the related entity.
  • Unique identifier of a related entity.
  • The lifecycleStatus of the related entity.
  • Name of the related entity.
  • 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" ]
    Describes the price, such as recurring, discount, allowance, penalty, and so forth
  • Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER" ]
    Used to indicate the type of product.
  • Allowed Values: [ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP" ]
    type of the profile
  • Allowed Values: [ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]
    Comma seperated promotion tags/type
  • Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
  • Version of the object
Nested Schema : context
Type: array
Show Source
Nested Schema : ProjectItemContextsOracle
Type: object
Title: ProjectItemContextsOracle
Project item context objects which holds the KPI parameters
Show Source
Nested Schema : params
Type: array
Show Source
Nested Schema : ProjectItemContextParamsOracle
Type: object
Title: ProjectItemContextParamsOracle
Project item context KPI parameters
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
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
Show Source

403 Response

You don't have authorization to perform this request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
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
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
Show Source

500 Response

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

Examples

The following example shows how to get a category by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project \ -H 'Content-Type: application/json'

Example of Response Body

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

[
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/Automation_project1594120527902",
        "id": "Automation_project1594120527902",
        "createdBy": "anonymous",
        "created": "2020-07-07T11:16:57.001Z",
        "lastUpdate": "2020-07-07T11:16:57.684Z",
        "lastUpdatedBy": "anonymous",
        "version": "1.0",
        "@type": "ProjectOracle",
        "lifecycleStatus": "In design",
        "name": "Automation_project1594120527902",
        "description": "Automation_project1594120527902     Description",
        "action": "CREATE_OBJECT"
    },  
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/28465",
        "id": "28465",
        "createdBy": "booth",
        "created": "2020-07-23T08:19:30.003Z",
        "lastUpdate": "2020-07-23T08:19:31.553Z",
        "lastUpdatedBy": "booth",
        "version": "1.0",
        "@type": "ProjectOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProjectOracle.yml",
        "lifecycleStatus": "In design",
        "name": "ImportJob_28465",
        "description": "Project for Import Job Id 28465",
        "action": "Import_Job",
        "projectItems": [
            {
                "id": "Bundlepopp121234",
                "@referredType": "ProductOfferingPriceOracle",
                "name": "Bundle popp121234",
                "version": "1.0"
            },
            {
                "id": "POPFirst",
                "@referredType": "ProductOfferingPriceOracle",
                "name": "POP First",
                "version": "1.0"
            },
            {
                "id": "POPSecond",
                "@referredType": "ProductOfferingPriceOracle",
                "name": "POP Second",
                "version": "1.0"
            }
        ]
    },
    
    ....
]
Back to Top