Jump to

• Request
• Response
• Examples

Create a project

post

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

This operation creates a Project entity.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

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

• object Project
  Title: Project

  Discriminator: { "propertyName":"@type", "mapping":{ "Project":"#/components/schemas/Project", "ProjectOracle":"#/components/schemas/ProjectOracle" } }

  Is a detailed description of the project
• object type

{
    "title":"ProjectOracle",
    "description":"Is a detailed description of the project",
    "allOf":[
        {
            "$ref":"#/components/schemas/Project"
        },
        {
            "type":"object",
            "properties":{
                "currentStatus":{
                    "type":"string",
                    "description":"Used to indicate the current status before state change."
                },
                "action":{
                    "type":"string",
                    "description":"Used to indicate the last action performed on the project"
                },
                "publishJobRef":{
                    "$ref":"#/components/schemas/PublishJobRef"
                },
                "projectItems":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProjectItemRef"
                    },
                    "description":"Contains the list of Catalog Objects"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "launchedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of project launched"
                },
                "targetReleaseDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Date of targeted release of project"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "approvalEnabled":{
                    "type":"boolean",
                    "description":"approval enabled flag"
                },
                "publishTrackingEnabled":{
                    "type":"boolean",
                    "description":"tracking enabled flag"
                },
                "subStatus":{
                    "type":"string",
                    "description":"sub status code"
                },
                "approvalHistory":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ApprovalHistory"
                    }
                },
                "teamEnabled":{
                    "type":"boolean",
                    "description":"The flag used to identify whether team is desgined to develop the intiative."
                },
                "rollbackType":{
                    "type":"string",
                    "description":"The type of rollback."
                },
                "projectType":{
                    "type":"string",
                    "description":"The type of project to show a rollback project."
                },
                "team":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TeamOracle"
                    }
                },
                "projectHistory":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProjectHistory"
                    }
                },
                "lifecycleConfiguration":{
                    "$ref":"#/components/schemas/LifecycleConfigurationRef"
                },
                "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 project"
                },
                "sourceProject":{
                    "$ref":"#/components/schemas/ProjectRef"
                }
            }
        }
    ]
}

Nested Schema : Project

Type: object

Title: Project

Discriminator: @type

Discriminator Values

• Project
• ProjectOracle

{
    "title":"Project",
    "type":"object",
    "description":"Is a detailed description of the project",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the Project"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "description":{
            "type":"string",
            "description":"A narrative that describes the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Project":"#/components/schemas/Project",
            "ProjectOracle":"#/components/schemas/ProjectOracle"
        }
    }
}

Is a detailed description of the project

Show Source

• @baseType: string
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class entity name
• description: string
  A narrative that describes the project
• href: string
  Reference of the Project
• id: string
  Maximum Length: 30

  Unique identifier of the Project
• lastUpdate: string (date-time)
  Date and time of the last update
• lifecycleStatus: string
  Used to indicate the current lifecycle status
• name(required): string
  Name of the project
• version: string
  Version of the object

{
    "title":"Project",
    "type":"object",
    "description":"Is a detailed description of the project",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the Project"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "description":{
            "type":"string",
            "description":"A narrative that describes the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Project":"#/components/schemas/Project",
            "ProjectOracle":"#/components/schemas/ProjectOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• action: string
  Used to indicate the last action performed on the project
• applicationName: string
  name of the external application
• approvalEnabled: boolean
  approval enabled flag
• approvalHistory: array approvalHistory
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• currentStatus: string
  Used to indicate the current status before state change.
• externalId: string
  id of the external application
• lastUpdatedBy: string
  name of the person who updated item
• launchedDate: string (date-time)
  Date and time of project launched
• lifecycleConfiguration: object LifecycleConfigurationRef
  Title: LifecycleConfigurationRef

  LifecycleConfiguration Reference
• projectHistory: array projectHistory
• projectItems: array projectItems
  Contains the list of Catalog Objects
• projectType: string
  The type of project to show a rollback project.
• publishJobRef: object PublishJobRef
  Title: PublishJobRef

  Publish Job reference. A Job describes the details of the publishing state
• publishTrackingEnabled: boolean
  tracking enabled flag
• rollbackType: string
  The type of rollback.
• sourceProject: object ProjectRef
  Title: ProjectRef

  Project Reference
• subStatus: string
  sub status code
• targetReleaseDate: string (date)
  Date of targeted release of project
• team: array team
• teamEnabled: boolean
  The flag used to identify whether team is desgined to develop the intiative.
• versionState: number
  Version state of the project

{
    "type":"object",
    "properties":{
        "currentStatus":{
            "type":"string",
            "description":"Used to indicate the current status before state change."
        },
        "action":{
            "type":"string",
            "description":"Used to indicate the last action performed on the project"
        },
        "publishJobRef":{
            "$ref":"#/components/schemas/PublishJobRef"
        },
        "projectItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemRef"
            },
            "description":"Contains the list of Catalog Objects"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "launchedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of project launched"
        },
        "targetReleaseDate":{
            "type":"string",
            "format":"date",
            "description":"Date of targeted release of project"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "approvalEnabled":{
            "type":"boolean",
            "description":"approval enabled flag"
        },
        "publishTrackingEnabled":{
            "type":"boolean",
            "description":"tracking enabled flag"
        },
        "subStatus":{
            "type":"string",
            "description":"sub status code"
        },
        "approvalHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ApprovalHistory"
            }
        },
        "teamEnabled":{
            "type":"boolean",
            "description":"The flag used to identify whether team is desgined to develop the intiative."
        },
        "rollbackType":{
            "type":"string",
            "description":"The type of rollback."
        },
        "projectType":{
            "type":"string",
            "description":"The type of project to show a rollback project."
        },
        "team":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TeamOracle"
            }
        },
        "projectHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectHistory"
            }
        },
        "lifecycleConfiguration":{
            "$ref":"#/components/schemas/LifecycleConfigurationRef"
        },
        "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 project"
        },
        "sourceProject":{
            "$ref":"#/components/schemas/ProjectRef"
        }
    }
}

Nested Schema : approvalHistory

Type: array

Show Source

• Array of: object ApprovalHistory
  Title: ApprovalHistory

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

Nested Schema : LifecycleConfigurationRef

Type: object

Title: LifecycleConfigurationRef

LifecycleConfiguration Reference

Show Source

• @referredType(required): string
  Class type of the lifecycle configuration
• href: string
  A string. Reference of the lifecycle configuration.
• id: string
  Maximum Length: 100

  A string. Unique identifier of the lifecycle configurations.
• name: string
  A string. Name of the lifecycle configuration.
• version: string
  A string. lifecycle configuration version.

{
    "title":"LifecycleConfigurationRef",
    "type":"object",
    "description":"LifecycleConfiguration Reference",
    "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."
        },
        "@referredType":{
            "type":"string",
            "description":"Class type of the lifecycle configuration"
        }
    },
    "required":[
        "@referredType"
    ]
}

Nested Schema : projectHistory

Type: array

Show Source

• Array of: object ProjectHistory
  Title: ProjectHistory

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

Nested Schema : projectItems

Type: array

Contains the list of Catalog Objects

Show Source

• Array of: object ProjectItemRef
  Title: ProjectItemRef

  Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectItemRef"
    },
    "description":"Contains the list of Catalog Objects"
}

Nested Schema : PublishJobRef

Type: object

Title: PublishJobRef

Publish Job reference. A Job describes the details of the publishing state

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  URL serving as reference for the Job resource
• id(required): string
  Unique-Identifier for this publish Job

{
    "title":"PublishJobRef",
    "type":"object",
    "description":"Publish Job reference. A Job describes the details of the publishing state",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique-Identifier for this publish Job"
        },
        "href":{
            "type":"string",
            "description":"URL serving as reference for the Job resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

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

Type: array

Show Source

• Array of: object TeamOracle
  Title: TeamOracle

  Team details of an initiative. Includes the name, role and email address of team member which is part of initiative.

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

Nested Schema : ApprovalHistory

Type: object

Title: ApprovalHistory

Show Source

• approvalAction: string
  A string. approval action.
• approvalDate: string (date-time)
  A date time (DateTime). Date and time of the approval.
• approvalFor: string
  A string. approval for.
• approver: string
  A string. approver.
• comments: string
  A string. A narrative that explains in detail what the approval history is.
• entityName: string
  Maximum Length: 100

  A string. Entity name.
• id(required): string
  Maximum Length: 100

  A string. Unique identifier of the approval history.
• projectId: string
  Maximum Length: 100

  A string. Unique identifier of the project id.
• projectName: string
  Maximum Length: 100

  A string. Project Name.
• requestor: string
  A string. requestor.

{
    "title":"ApprovalHistory",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Unique identifier of the approval history."
        },
        "approvalAction":{
            "type":"string",
            "description":"A string. approval action."
        },
        "approvalFor":{
            "type":"string",
            "description":"A string. approval for."
        },
        "requestor":{
            "type":"string",
            "description":"A string. requestor."
        },
        "approver":{
            "type":"string",
            "description":"A string. approver."
        },
        "comments":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the approval history is."
        },
        "approvalDate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the approval."
        },
        "projectId":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Unique identifier of the project id."
        },
        "projectName":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Project Name."
        },
        "entityName":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Entity name."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ProjectHistory

Type: object

Title: ProjectHistory

Show Source

• action: string
  A string. action.
• entityName: string
  Maximum Length: 100

  A string. Entity Name.
• id(required): string
  Maximum Length: 100

  A string. Unique identifier of the project history.
• stateFrom: string
  A string. State From.
• stateTo: string
  A string. State To.

{
    "title":"ProjectHistory",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Unique identifier of the project history."
        },
        "action":{
            "type":"string",
            "description":"A string. action."
        },
        "stateFrom":{
            "type":"string",
            "description":"A string. State From."
        },
        "stateTo":{
            "type":"string",
            "description":"A string. State To."
        },
        "entityName":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Entity Name."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ProjectItemRef

Type: object

Title: ProjectItemRef

Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..

Show Source

• @refBaseType: string
  The TMF base type of the target instance when needed for disambiguation.
• @referredType(required): string
  The actual type of the target instance when needed for disambiguation.
• context: array context
• entitlementType: string
  Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]

  entitlememt type
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• lifecycleStatus: string
  The lifecycleStatus of the related entity.
• name: string
  Name of the related entity.
• priceType: string
  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
• productType: string
  Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER" ]

  Used to indicate the type of product.
• profileType: string
  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
• promotionType: string
  Allowed Values: [ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]

  Comma seperated promotion tags/type
• ruleType: string
  Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
• version: string
  Version of the object

{
    "title":"ProjectItemRef",
    "type":"object",
    "description":"Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The lifecycleStatus of the related entity."
        },
        "context":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemContextsOracle"
            }
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "@refBaseType":{
            "type":"string",
            "description":"The TMF base type of the target instance when needed for disambiguation."
        },
        "priceType":{
            "type":"string",
            "description":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "enum":[
                "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"
            ]
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ]
        },
        "entitlementType":{
            "type":"string",
            "description":"entitlememt type",
            "enum":[
                "ENTITLEMENT_PRICING",
                "ENTITLEMENT_SERVICE"
            ]
        },
        "promotionType":{
            "type":"string",
            "description":"Comma seperated promotion tags/type",
            "enum":[
                "AWARD",
                "DISCOUNT",
                "TRADE_IN",
                "CROSS_PRODUCT_DISCOUNT"
            ]
        },
        "profileType":{
            "type":"string",
            "description":"type of the profile",
            "enum":[
                "DEVICE_SPEC",
                "BUSINESS_CONFIG",
                "TRADE_IN",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "RENEWAL_TERM",
                "FINANCE_PLAN",
                "ZONE_VALUE_MAP"
            ]
        },
        "productType":{
            "type":"string",
            "description":"Used to indicate the type of product.",
            "enum":[
                "PACKAGE",
                "COMMERCIAL_BUNDLE",
                "SERVICE_BUNDLE",
                "SERVICE",
                "DEVICE",
                "ACCESSORY",
                "CHOICE",
                "AGGREGATION",
                "SYSTEM_OFFER"
            ]
        }
    },
    "required":[
        "id",
        "@referredType"
    ]
}

Nested Schema : context

Type: array

Show Source

• Array of: object ProjectItemContextsOracle
  Title: ProjectItemContextsOracle

  Project item context objects which holds the KPI parameters

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

Nested Schema : ProjectItemContextsOracle

Type: object

Title: ProjectItemContextsOracle

Project item context objects which holds the KPI parameters

Show Source

• params(required): array params
• type(required): string
  Allowed Values: [ "ACQUISITION", "RETENTION" ]

  Used to indicate the context type

{
    "title":"ProjectItemContextsOracle",
    "type":"object",
    "description":"Project item context objects which holds the KPI parameters",
    "properties":{
        "type":{
            "type":"string",
            "description":"Used to indicate the context type",
            "enum":[
                "ACQUISITION",
                "RETENTION"
            ]
        },
        "params":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemContextParamsOracle"
            }
        }
    },
    "required":[
        "type",
        "params"
    ]
}

Nested Schema : params

Type: array

Show Source

• Array of: object ProjectItemContextParamsOracle
  Title: ProjectItemContextParamsOracle

  Project item context KPI parameters

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

Nested Schema : ProjectItemContextParamsOracle

Type: object

Title: ProjectItemContextParamsOracle

Project item context KPI parameters

Show Source

• key(required): string
  Key of the context parameter.
• name(required): string
  Name of the context parameter.
• value(required): string
  Value of the context parameter.

{
    "title":"ProjectItemContextParamsOracle",
    "type":"object",
    "description":"Project item context KPI parameters ",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key of the context parameter."
        },
        "value":{
            "type":"string",
            "description":"Value of the context parameter."
        },
        "name":{
            "type":"string",
            "description":"Name of the context parameter."
        }
    },
    "required":[
        "key",
        "value",
        "name"
    ]
}

Nested Schema : TeamOracle

Type: object

Title: TeamOracle

Team details of an initiative. Includes the name, role and email address of team member which is part of initiative.

Show Source

• emailAddress: string
  Email address of the team member
• id: string
  Unique identifier of a team member.
• isPrimary: boolean
  Indicates the team member is a primary one or not.
• name: string
  Name of the team member.
• partyNumber: string
  Party number for a team member.
• roleCode: string
  Role code of the team member

{
    "title":"TeamOracle",
    "type":"object",
    "description":"Team details of an initiative. Includes the name, role and email address of team member which is part of initiative.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a team member."
        },
        "name":{
            "type":"string",
            "description":"Name of the team member."
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address of the team member"
        },
        "partyNumber":{
            "type":"string",
            "description":"Party number for a team member."
        },
        "roleCode":{
            "type":"string",
            "description":"Role code of the team member"
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Indicates the team member is a primary one or not."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Your request is successful and a new resource has been created.

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

• object Project
  Title: Project

  Discriminator: { "propertyName":"@type", "mapping":{ "Project":"#/components/schemas/Project", "ProjectOracle":"#/components/schemas/ProjectOracle" } }

  Is a detailed description of the project
• object type

{
    "title":"ProjectOracle",
    "description":"Is a detailed description of the project",
    "allOf":[
        {
            "$ref":"#/components/schemas/Project"
        },
        {
            "type":"object",
            "properties":{
                "currentStatus":{
                    "type":"string",
                    "description":"Used to indicate the current status before state change."
                },
                "action":{
                    "type":"string",
                    "description":"Used to indicate the last action performed on the project"
                },
                "publishJobRef":{
                    "$ref":"#/components/schemas/PublishJobRef"
                },
                "projectItems":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProjectItemRef"
                    },
                    "description":"Contains the list of Catalog Objects"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "launchedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of project launched"
                },
                "targetReleaseDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Date of targeted release of project"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "approvalEnabled":{
                    "type":"boolean",
                    "description":"approval enabled flag"
                },
                "publishTrackingEnabled":{
                    "type":"boolean",
                    "description":"tracking enabled flag"
                },
                "subStatus":{
                    "type":"string",
                    "description":"sub status code"
                },
                "approvalHistory":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ApprovalHistory"
                    }
                },
                "teamEnabled":{
                    "type":"boolean",
                    "description":"The flag used to identify whether team is desgined to develop the intiative."
                },
                "rollbackType":{
                    "type":"string",
                    "description":"The type of rollback."
                },
                "projectType":{
                    "type":"string",
                    "description":"The type of project to show a rollback project."
                },
                "team":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TeamOracle"
                    }
                },
                "projectHistory":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProjectHistory"
                    }
                },
                "lifecycleConfiguration":{
                    "$ref":"#/components/schemas/LifecycleConfigurationRef"
                },
                "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 project"
                },
                "sourceProject":{
                    "$ref":"#/components/schemas/ProjectRef"
                }
            }
        }
    ]
}

Nested Schema : Project

Type: object

Title: Project

Discriminator: @type

Discriminator Values

• Project
• ProjectOracle

{
    "title":"Project",
    "type":"object",
    "description":"Is a detailed description of the project",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the Project"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "description":{
            "type":"string",
            "description":"A narrative that describes the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Project":"#/components/schemas/Project",
            "ProjectOracle":"#/components/schemas/ProjectOracle"
        }
    }
}

Is a detailed description of the project

Show Source

• @baseType: string
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class entity name
• description: string
  A narrative that describes the project
• href: string
  Reference of the Project
• id: string
  Maximum Length: 30

  Unique identifier of the Project
• lastUpdate: string (date-time)
  Date and time of the last update
• lifecycleStatus: string
  Used to indicate the current lifecycle status
• name(required): string
  Name of the project
• version: string
  Version of the object

{
    "title":"Project",
    "type":"object",
    "description":"Is a detailed description of the project",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the Project"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "description":{
            "type":"string",
            "description":"A narrative that describes the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Project":"#/components/schemas/Project",
            "ProjectOracle":"#/components/schemas/ProjectOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• action: string
  Used to indicate the last action performed on the project
• applicationName: string
  name of the external application
• approvalEnabled: boolean
  approval enabled flag
• approvalHistory: array approvalHistory
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• currentStatus: string
  Used to indicate the current status before state change.
• externalId: string
  id of the external application
• lastUpdatedBy: string
  name of the person who updated item
• launchedDate: string (date-time)
  Date and time of project launched
• lifecycleConfiguration: object LifecycleConfigurationRef
  Title: LifecycleConfigurationRef

  LifecycleConfiguration Reference
• projectHistory: array projectHistory
• projectItems: array projectItems
  Contains the list of Catalog Objects
• projectType: string
  The type of project to show a rollback project.
• publishJobRef: object PublishJobRef
  Title: PublishJobRef

  Publish Job reference. A Job describes the details of the publishing state
• publishTrackingEnabled: boolean
  tracking enabled flag
• rollbackType: string
  The type of rollback.
• sourceProject: object ProjectRef
  Title: ProjectRef

  Project Reference
• subStatus: string
  sub status code
• targetReleaseDate: string (date)
  Date of targeted release of project
• team: array team
• teamEnabled: boolean
  The flag used to identify whether team is desgined to develop the intiative.
• versionState: number
  Version state of the project

{
    "type":"object",
    "properties":{
        "currentStatus":{
            "type":"string",
            "description":"Used to indicate the current status before state change."
        },
        "action":{
            "type":"string",
            "description":"Used to indicate the last action performed on the project"
        },
        "publishJobRef":{
            "$ref":"#/components/schemas/PublishJobRef"
        },
        "projectItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemRef"
            },
            "description":"Contains the list of Catalog Objects"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "launchedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of project launched"
        },
        "targetReleaseDate":{
            "type":"string",
            "format":"date",
            "description":"Date of targeted release of project"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "approvalEnabled":{
            "type":"boolean",
            "description":"approval enabled flag"
        },
        "publishTrackingEnabled":{
            "type":"boolean",
            "description":"tracking enabled flag"
        },
        "subStatus":{
            "type":"string",
            "description":"sub status code"
        },
        "approvalHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ApprovalHistory"
            }
        },
        "teamEnabled":{
            "type":"boolean",
            "description":"The flag used to identify whether team is desgined to develop the intiative."
        },
        "rollbackType":{
            "type":"string",
            "description":"The type of rollback."
        },
        "projectType":{
            "type":"string",
            "description":"The type of project to show a rollback project."
        },
        "team":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TeamOracle"
            }
        },
        "projectHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectHistory"
            }
        },
        "lifecycleConfiguration":{
            "$ref":"#/components/schemas/LifecycleConfigurationRef"
        },
        "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 project"
        },
        "sourceProject":{
            "$ref":"#/components/schemas/ProjectRef"
        }
    }
}

Nested Schema : approvalHistory

Type: array

Show Source

• Array of: object ApprovalHistory
  Title: ApprovalHistory

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

Nested Schema : LifecycleConfigurationRef

Type: object

Title: LifecycleConfigurationRef

LifecycleConfiguration Reference

Show Source

• @referredType(required): string
  Class type of the lifecycle configuration
• href: string
  A string. Reference of the lifecycle configuration.
• id: string
  Maximum Length: 100

  A string. Unique identifier of the lifecycle configurations.
• name: string
  A string. Name of the lifecycle configuration.
• version: string
  A string. lifecycle configuration version.

{
    "title":"LifecycleConfigurationRef",
    "type":"object",
    "description":"LifecycleConfiguration Reference",
    "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."
        },
        "@referredType":{
            "type":"string",
            "description":"Class type of the lifecycle configuration"
        }
    },
    "required":[
        "@referredType"
    ]
}

Nested Schema : projectHistory

Type: array

Show Source

• Array of: object ProjectHistory
  Title: ProjectHistory

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

Nested Schema : projectItems

Type: array

Contains the list of Catalog Objects

Show Source

• Array of: object ProjectItemRef
  Title: ProjectItemRef

  Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectItemRef"
    },
    "description":"Contains the list of Catalog Objects"
}

Nested Schema : PublishJobRef

Type: object

Title: PublishJobRef

Publish Job reference. A Job describes the details of the publishing state

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  URL serving as reference for the Job resource
• id(required): string
  Unique-Identifier for this publish Job

{
    "title":"PublishJobRef",
    "type":"object",
    "description":"Publish Job reference. A Job describes the details of the publishing state",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique-Identifier for this publish Job"
        },
        "href":{
            "type":"string",
            "description":"URL serving as reference for the Job resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

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

Type: array

Show Source

• Array of: object TeamOracle
  Title: TeamOracle

  Team details of an initiative. Includes the name, role and email address of team member which is part of initiative.

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

Nested Schema : ApprovalHistory

Type: object

Title: ApprovalHistory

Show Source

• approvalAction: string
  A string. approval action.
• approvalDate: string (date-time)
  A date time (DateTime). Date and time of the approval.
• approvalFor: string
  A string. approval for.
• approver: string
  A string. approver.
• comments: string
  A string. A narrative that explains in detail what the approval history is.
• entityName: string
  Maximum Length: 100

  A string. Entity name.
• id(required): string
  Maximum Length: 100

  A string. Unique identifier of the approval history.
• projectId: string
  Maximum Length: 100

  A string. Unique identifier of the project id.
• projectName: string
  Maximum Length: 100

  A string. Project Name.
• requestor: string
  A string. requestor.

{
    "title":"ApprovalHistory",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Unique identifier of the approval history."
        },
        "approvalAction":{
            "type":"string",
            "description":"A string. approval action."
        },
        "approvalFor":{
            "type":"string",
            "description":"A string. approval for."
        },
        "requestor":{
            "type":"string",
            "description":"A string. requestor."
        },
        "approver":{
            "type":"string",
            "description":"A string. approver."
        },
        "comments":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the approval history is."
        },
        "approvalDate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the approval."
        },
        "projectId":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Unique identifier of the project id."
        },
        "projectName":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Project Name."
        },
        "entityName":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Entity name."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ProjectHistory

Type: object

Title: ProjectHistory

Show Source

• action: string
  A string. action.
• entityName: string
  Maximum Length: 100

  A string. Entity Name.
• id(required): string
  Maximum Length: 100

  A string. Unique identifier of the project history.
• stateFrom: string
  A string. State From.
• stateTo: string
  A string. State To.

{
    "title":"ProjectHistory",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Unique identifier of the project history."
        },
        "action":{
            "type":"string",
            "description":"A string. action."
        },
        "stateFrom":{
            "type":"string",
            "description":"A string. State From."
        },
        "stateTo":{
            "type":"string",
            "description":"A string. State To."
        },
        "entityName":{
            "type":"string",
            "maxLength":100,
            "description":"A string. Entity Name."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ProjectItemRef

Type: object

Title: ProjectItemRef

Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..

Show Source

• @refBaseType: string
  The TMF base type of the target instance when needed for disambiguation.
• @referredType(required): string
  The actual type of the target instance when needed for disambiguation.
• context: array context
• entitlementType: string
  Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]

  entitlememt type
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• lifecycleStatus: string
  The lifecycleStatus of the related entity.
• name: string
  Name of the related entity.
• priceType: string
  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
• productType: string
  Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER" ]

  Used to indicate the type of product.
• profileType: string
  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
• promotionType: string
  Allowed Values: [ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]

  Comma seperated promotion tags/type
• ruleType: string
  Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
• version: string
  Version of the object

{
    "title":"ProjectItemRef",
    "type":"object",
    "description":"Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The lifecycleStatus of the related entity."
        },
        "context":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemContextsOracle"
            }
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "@refBaseType":{
            "type":"string",
            "description":"The TMF base type of the target instance when needed for disambiguation."
        },
        "priceType":{
            "type":"string",
            "description":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "enum":[
                "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"
            ]
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ]
        },
        "entitlementType":{
            "type":"string",
            "description":"entitlememt type",
            "enum":[
                "ENTITLEMENT_PRICING",
                "ENTITLEMENT_SERVICE"
            ]
        },
        "promotionType":{
            "type":"string",
            "description":"Comma seperated promotion tags/type",
            "enum":[
                "AWARD",
                "DISCOUNT",
                "TRADE_IN",
                "CROSS_PRODUCT_DISCOUNT"
            ]
        },
        "profileType":{
            "type":"string",
            "description":"type of the profile",
            "enum":[
                "DEVICE_SPEC",
                "BUSINESS_CONFIG",
                "TRADE_IN",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "RENEWAL_TERM",
                "FINANCE_PLAN",
                "ZONE_VALUE_MAP"
            ]
        },
        "productType":{
            "type":"string",
            "description":"Used to indicate the type of product.",
            "enum":[
                "PACKAGE",
                "COMMERCIAL_BUNDLE",
                "SERVICE_BUNDLE",
                "SERVICE",
                "DEVICE",
                "ACCESSORY",
                "CHOICE",
                "AGGREGATION",
                "SYSTEM_OFFER"
            ]
        }
    },
    "required":[
        "id",
        "@referredType"
    ]
}

Nested Schema : context

Type: array

Show Source

• Array of: object ProjectItemContextsOracle
  Title: ProjectItemContextsOracle

  Project item context objects which holds the KPI parameters

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

Nested Schema : ProjectItemContextsOracle

Type: object

Title: ProjectItemContextsOracle

Project item context objects which holds the KPI parameters

Show Source

• params(required): array params
• type(required): string
  Allowed Values: [ "ACQUISITION", "RETENTION" ]

  Used to indicate the context type

{
    "title":"ProjectItemContextsOracle",
    "type":"object",
    "description":"Project item context objects which holds the KPI parameters",
    "properties":{
        "type":{
            "type":"string",
            "description":"Used to indicate the context type",
            "enum":[
                "ACQUISITION",
                "RETENTION"
            ]
        },
        "params":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemContextParamsOracle"
            }
        }
    },
    "required":[
        "type",
        "params"
    ]
}

Nested Schema : params

Type: array

Show Source

• Array of: object ProjectItemContextParamsOracle
  Title: ProjectItemContextParamsOracle

  Project item context KPI parameters

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

Nested Schema : ProjectItemContextParamsOracle

Type: object

Title: ProjectItemContextParamsOracle

Project item context KPI parameters

Show Source

• key(required): string
  Key of the context parameter.
• name(required): string
  Name of the context parameter.
• value(required): string
  Value of the context parameter.

{
    "title":"ProjectItemContextParamsOracle",
    "type":"object",
    "description":"Project item context KPI parameters ",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key of the context parameter."
        },
        "value":{
            "type":"string",
            "description":"Value of the context parameter."
        },
        "name":{
            "type":"string",
            "description":"Name of the context parameter."
        }
    },
    "required":[
        "key",
        "value",
        "name"
    ]
}

Nested Schema : TeamOracle

Type: object

Title: TeamOracle

Team details of an initiative. Includes the name, role and email address of team member which is part of initiative.

Show Source

• emailAddress: string
  Email address of the team member
• id: string
  Unique identifier of a team member.
• isPrimary: boolean
  Indicates the team member is a primary one or not.
• name: string
  Name of the team member.
• partyNumber: string
  Party number for a team member.
• roleCode: string
  Role code of the team member

{
    "title":"TeamOracle",
    "type":"object",
    "description":"Team details of an initiative. Includes the name, role and email address of team member which is part of initiative.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a team member."
        },
        "name":{
            "type":"string",
            "description":"Name of the team member."
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address of the team member"
        },
        "partyNumber":{
            "type":"string",
            "description":"Party number for a team member."
        },
        "roleCode":{
            "type":"string",
            "description":"Role code of the team member"
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Indicates the team member is a primary one or not."
        }
    }
}

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

• @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.

Body ()

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"
    ]
}

403 Response

You don't have authorization to perform this request.

Body ()

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.

Body ()

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.

Body ()

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"
    ]
}

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

• @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.

Body ()

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"
    ]
}

Back to Top

Examples

The following example shows how to create a project by submitting a POST request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
    "id": "SpringProject",
    "version": "1.0",
    "@type": "ProjectOracle",
    "lifecycleStatus": "In design",
    "name": "SpringProject",
    "description": "This project includes all our offerings, specifications and catalogs for SpringProject"
}

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 SpringProject",
    "@type": "ProjectOracle",
    "version": "1.0",
    "action": "CREATE_OBJECT",
    "lifecycleStatus": "In design",
    "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"
    }
}

Back to Top