Jump to

• Request
• Response

Create one product launch request

post

/fscmRestApi/resources/11.13.18.05/productLaunchDefinitions

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CopyMeasureDataFg: integer (int32)
  Indicates whether the selection of measures to be copied from the source product to the new product combinations is allowed. The valid values are 0, 1, and NULL. When the value is 1 or NULL, the selection of measures to be copied from the source product to the new product combinations is allowed. When the value is 0, the selection of measures isn't allowed for the product launch request.
• LastCopyDate: string (date-time)
  Date when the measure data was most recently copied from the source product to the new product combinations.
• LaunchDate: string (date)
  Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.
• NewProductId(required): integer
  Unique identifier of the new product.
• NewProductName: string
  Name of the new product.
• npiCustomers: array Definition of Product Launch Request Customers
  Title: Definition of Product Launch Request Customers

  List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.
• NpiDefId: integer
  Unique identifier of the product launch request.
• npiMeasures: array Product Launch Request Measure Copy Definition
  Title: Product Launch Request Measure Copy Definition

  Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.
• npiOrganizations: array Definition of Product Launch Request Organizations
  Title: Definition of Product Launch Request Organizations

  List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.
• organizationCustomerCombinations: array Product Launch Request Organization Customer Combination Definition
  Title: Product Launch Request Organization Customer Combination Definition

  Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.
• PlanId: integer
  Unique identifier of the plan associated with the product launch request.
• ProcessEndDateFg: integer (int32)
  Indicates whether all customer sites and organizations selected for the new product launch request have the same process end date. The valid values are 0, 1, and NULL. When the value is 1, all customer sites and organizations have the same process end date. When the value is 0 or NULL, customer sites and organizations may have different process end dates.
• SourceCusOrgFg: integer (int32)
  Indicates whether all source product customer sites and organizations are selected for the new product launch request. The valid values are 1, 2, and NULL. When the value is 1, all source product customer sites and organizations are selected. When the value is 2 or NULL, specific source product customer sites and organizations are selected for the launch request.
• SourceProductId(required): integer
  Unique identifier of the source product.
• SourceProductName: string
  Name of the source product.
• Status: string
  Default Value: 1

  Unique identifier of the product launch request status.
• StatusName: string
  Status of the product launch request. Valid values are In Progress, Active, and Completed.

{
    "required":[
        "NewProductId",
        "SourceProductId"
    ],
    "type":"object",
    "properties":{
        "CopyMeasureDataFg":{
            "type":"integer",
            "description":"Indicates whether the selection of measures to be copied from the source product to the new product combinations is allowed. The valid values are 0, 1, and NULL. When the value is 1 or NULL, the selection of measures to be copied from the source product to the new product combinations is allowed. When the value is 0, the selection of measures isn't allowed for the product launch request.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "LastCopyDate":{
            "type":"string",
            "description":"Date when the measure data was most recently copied from the source product to the new product combinations.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LaunchDate":{
            "type":"string",
            "description":"Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.",
            "format":"date",
            "nullable":true
        },
        "NewProductId":{
            "type":"integer",
            "description":"Unique identifier of the new product.",
            "nullable":false,
            "x-queryable":false
        },
        "NewProductName":{
            "type":"string",
            "description":"Name of the new product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "NewProductId"
                ]
            }
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Unique identifier of the product launch request.",
            "nullable":false,
            "x-queryable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the product launch request.",
            "nullable":true
        },
        "ProcessEndDateFg":{
            "type":"integer",
            "description":"Indicates whether all customer sites and organizations selected for the new product launch request have the same process end date. The valid values are 0, 1, and NULL. When the value is 1, all customer sites and organizations have the same process end date. When the value is 0 or NULL, customer sites and organizations may have different process end dates.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "SourceCusOrgFg":{
            "type":"integer",
            "description":"Indicates whether all source product customer sites and organizations are selected for the new product launch request. The valid values are 1, 2, and NULL. When the value is 1, all source product customer sites and organizations are selected. When the value is 2 or NULL, specific source product customer sites and organizations are selected for the launch request.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "SourceProductId":{
            "type":"integer",
            "description":"Unique identifier of the source product.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "SourceProductName":{
            "type":"string",
            "description":"Name of the source product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceProductId"
                ]
            }
        },
        "Status":{
            "type":"string",
            "description":"Unique identifier of the product launch request status.",
            "nullable":true,
            "default":"1"
        },
        "StatusName":{
            "type":"string",
            "description":"Status of the product launch request. Valid values are In Progress, Active, and Completed.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status"
                ]
            }
        },
        "npiCustomers":{
            "title":"Definition of Product Launch Request Customers",
            "type":"array",
            "description":"List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-npiCustomers-item-post-request"
            }
        },
        "npiMeasures":{
            "title":"Product Launch Request Measure Copy Definition",
            "type":"array",
            "description":"Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-npiMeasures-item-post-request"
            }
        },
        "npiOrganizations":{
            "title":"Definition of Product Launch Request Organizations",
            "type":"array",
            "description":"List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-npiOrganizations-item-post-request"
            }
        },
        "organizationCustomerCombinations":{
            "title":"Product Launch Request Organization Customer Combination Definition",
            "type":"array",
            "description":"Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-organizationCustomerCombinations-item-post-request"
            }
        }
    }
}

Nested Schema : Definition of Product Launch Request Customers

Type: array

Title: Definition of Product Launch Request Customers

List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.

Show Source

• Array of: object productLaunchDefinitions-npiCustomers-item-post-request

{
    "title":"Definition of Product Launch Request Customers",
    "type":"array",
    "description":"List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-npiCustomers-item-post-request"
    }
}

Nested Schema : Product Launch Request Measure Copy Definition

Type: array

Title: Product Launch Request Measure Copy Definition

Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.

Show Source

• Array of: object productLaunchDefinitions-npiMeasures-item-post-request

{
    "title":"Product Launch Request Measure Copy Definition",
    "type":"array",
    "description":"Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-npiMeasures-item-post-request"
    }
}

Nested Schema : Definition of Product Launch Request Organizations

Type: array

Title: Definition of Product Launch Request Organizations

List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.

Show Source

• Array of: object productLaunchDefinitions-npiOrganizations-item-post-request

{
    "title":"Definition of Product Launch Request Organizations",
    "type":"array",
    "description":"List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-npiOrganizations-item-post-request"
    }
}

Nested Schema : Product Launch Request Organization Customer Combination Definition

Type: array

Title: Product Launch Request Organization Customer Combination Definition

Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.

Show Source

• Array of: object productLaunchDefinitions-organizationCustomerCombinations-item-post-request

{
    "title":"Product Launch Request Organization Customer Combination Definition",
    "type":"array",
    "description":"Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-organizationCustomerCombinations-item-post-request"
    }
}

Nested Schema : productLaunchDefinitions-npiCustomers-item-post-request

Type: object

Show Source

• CustomerName: string
  Name of the customer.
• CustomerSiteId: integer
  Unique identifier of the customer site.
• CustomerSiteName: string
  Name of the customer site.
• PlanId: integer
  Unique identifier of the plan associated with the product launch request.
• SourceProductId: integer
  Unique identifier of the source product.

{
    "type":"object",
    "properties":{
        "CustomerName":{
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Unique identifier of the customer site.",
            "nullable":true
        },
        "CustomerSiteName":{
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the product launch request.",
            "nullable":true
        },
        "SourceProductId":{
            "type":"integer",
            "description":"Unique identifier of the source product.",
            "nullable":true
        }
    }
}

Nested Schema : productLaunchDefinitions-npiMeasures-item-post-request

Type: object

Show Source

• AddDelFg: integer
  Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.
• FactorPct: number
  Percentage factor associated with the measure copy definition.
• NpiDefId: integer
  Unique identifier of the product launch request.
• NpiMeasureId: integer
  Unique identifier of the measure copy definition.
• SourceMeasureId: integer
  Unique identifier of the source measure.
• TargetMeasureId: integer
  Title: Target Measure

  Unique identifier of the target measure.

{
    "type":"object",
    "properties":{
        "AddDelFg":{
            "type":"integer",
            "description":"Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.",
            "nullable":true
        },
        "FactorPct":{
            "type":"number",
            "description":"Percentage factor associated with the measure copy definition.",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Unique identifier of the product launch request.",
            "nullable":false
        },
        "NpiMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure copy definition.",
            "nullable":false
        },
        "SourceMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the source measure.",
            "nullable":false
        },
        "TargetMeasureId":{
            "title":"Target Measure",
            "type":"integer",
            "description":"Unique identifier of the target measure.",
            "nullable":false
        }
    }
}

Nested Schema : productLaunchDefinitions-npiOrganizations-item-post-request

Type: object

Show Source

• NewProductId: integer
  Unique identifier of the new product.
• OrganizationId: integer
  Unique identifier of the organization.
• OrganizationName: string
  Name of the organization.
• PlanId: integer
  Unique identifier of the plan associated with the product launch request.
• SourceProductId: integer
  Unique identifier of the source product.

{
    "type":"object",
    "properties":{
        "NewProductId":{
            "type":"integer",
            "description":"Unique identifier of the new product.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "nullable":true
        },
        "OrganizationName":{
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the product launch request.",
            "nullable":true
        },
        "SourceProductId":{
            "type":"integer",
            "description":"Unique identifier of the source product.",
            "nullable":true
        }
    }
}

Nested Schema : productLaunchDefinitions-organizationCustomerCombinations-item-post-request

Type: object

Show Source

• AddDelFg: integer
  Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.
• CopyFlag: boolean
  Indicates the type of copy associated with the new product launch definition. A value of 1 means that measure data is copied from the source product to the target product combinations, while a value of 0 indicates that only organization customer site combinations are created for the target product without data copy.
• IsLaunched: string
  Indicates whether the process end date of the new product launch definition has reached the current date. A value of 1 means the process end date has reached the current date, while a value of 0 means it hasn't.
• LaunchDt: string (date)
  Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.
• NpiCombId: integer
  Unique identifier of the organization customer site combination.
• NpiDefId: integer
  Value that uniquely identifies the product launch request.
• OrgId: integer
  Unique identifier of the organization.
• SiteId: integer
  Unique identifier of the customer site.

{
    "type":"object",
    "properties":{
        "AddDelFg":{
            "type":"integer",
            "description":"Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.",
            "nullable":true
        },
        "CopyFlag":{
            "type":"boolean",
            "description":"Indicates the type of copy associated with the new product launch definition. A value of 1 means that measure data is copied from the source product to the target product combinations, while a value of 0 indicates that only organization customer site combinations are created for the target product without data copy.",
            "nullable":false
        },
        "IsLaunched":{
            "type":"string",
            "description":"Indicates whether the process end date of the new product launch definition has reached the current date. A value of 1 means the process end date has reached the current date, while a value of 0 means it hasn't.",
            "nullable":true
        },
        "LaunchDt":{
            "type":"string",
            "description":"Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.",
            "format":"date",
            "nullable":true
        },
        "NpiCombId":{
            "type":"integer",
            "description":"Unique identifier of the organization customer site combination.",
            "nullable":false
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product launch request.",
            "nullable":false
        },
        "OrgId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "nullable":false
        },
        "SiteId":{
            "type":"integer",
            "description":"Unique identifier of the customer site.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productLaunchDefinitions-item-response

Type: object

Show Source

• CopyMeasureDataFg: integer (int32)
  Indicates whether the selection of measures to be copied from the source product to the new product combinations is allowed. The valid values are 0, 1, and NULL. When the value is 1 or NULL, the selection of measures to be copied from the source product to the new product combinations is allowed. When the value is 0, the selection of measures isn't allowed for the product launch request.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the product launch request.
• CreatedDate: string (date-time)
  Read Only: true

  Date when the product launch request was created.
• LastCopyDate: string (date-time)
  Date when the measure data was most recently copied from the source product to the new product combinations.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the product launch request definition.
• LastUpdatedDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the product launch request definition.
• LaunchDate: string (date)
  Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewProductId: integer
  Unique identifier of the new product.
• NewProductName: string
  Name of the new product.
• npiCustomers: array Definition of Product Launch Request Customers
  Title: Definition of Product Launch Request Customers

  List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.
• NpiDefId: integer
  Unique identifier of the product launch request.
• npiMeasures: array Product Launch Request Measure Copy Definition
  Title: Product Launch Request Measure Copy Definition

  Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.
• npiOrganizations: array Definition of Product Launch Request Organizations
  Title: Definition of Product Launch Request Organizations

  List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.
• organizationCustomerCombinations: array Product Launch Request Organization Customer Combination Definition
  Title: Product Launch Request Organization Customer Combination Definition

  Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.
• PlanId: integer
  Unique identifier of the plan associated with the product launch request.
• PlanName: string
  Read Only: true

  Maximum Length: 255

  Name of the plan associated with the product launch request.
• ProcessEndDateFg: integer (int32)
  Indicates whether all customer sites and organizations selected for the new product launch request have the same process end date. The valid values are 0, 1, and NULL. When the value is 1, all customer sites and organizations have the same process end date. When the value is 0 or NULL, customer sites and organizations may have different process end dates.
• SourceCusOrgFg: integer (int32)
  Indicates whether all source product customer sites and organizations are selected for the new product launch request. The valid values are 1, 2, and NULL. When the value is 1, all source product customer sites and organizations are selected. When the value is 2 or NULL, specific source product customer sites and organizations are selected for the launch request.
• SourceProductId: integer
  Unique identifier of the source product.
• SourceProductName: string
  Name of the source product.
• Status: string
  Default Value: 1

  Unique identifier of the product launch request status.
• StatusName: string
  Status of the product launch request. Valid values are In Progress, Active, and Completed.

{
    "type":"object",
    "properties":{
        "CopyMeasureDataFg":{
            "type":"integer",
            "description":"Indicates whether the selection of measures to be copied from the source product to the new product combinations is allowed. The valid values are 0, 1, and NULL. When the value is 1 or NULL, the selection of measures to be copied from the source product to the new product combinations is allowed. When the value is 0, the selection of measures isn't allowed for the product launch request.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the product launch request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedDate":{
            "type":"string",
            "description":"Date when the product launch request was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastCopyDate":{
            "type":"string",
            "description":"Date when the measure data was most recently copied from the source product to the new product combinations.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the product launch request definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the user most recently updated the product launch request definition.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LaunchDate":{
            "type":"string",
            "description":"Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NewProductId":{
            "type":"integer",
            "description":"Unique identifier of the new product.",
            "nullable":false,
            "x-queryable":false
        },
        "NewProductName":{
            "type":"string",
            "description":"Name of the new product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "NewProductId"
                ]
            },
            "x-queryable":true
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Unique identifier of the product launch request.",
            "nullable":false,
            "x-queryable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the product launch request.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the plan associated with the product launch request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessEndDateFg":{
            "type":"integer",
            "description":"Indicates whether all customer sites and organizations selected for the new product launch request have the same process end date. The valid values are 0, 1, and NULL. When the value is 1, all customer sites and organizations have the same process end date. When the value is 0 or NULL, customer sites and organizations may have different process end dates.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SourceCusOrgFg":{
            "type":"integer",
            "description":"Indicates whether all source product customer sites and organizations are selected for the new product launch request. The valid values are 1, 2, and NULL. When the value is 1, all source product customer sites and organizations are selected. When the value is 2 or NULL, specific source product customer sites and organizations are selected for the launch request.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SourceProductId":{
            "type":"integer",
            "description":"Unique identifier of the source product.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SourceProductName":{
            "type":"string",
            "description":"Name of the source product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceProductId"
                ]
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Unique identifier of the product launch request status.",
            "nullable":true,
            "default":"1",
            "x-queryable":true
        },
        "StatusName":{
            "type":"string",
            "description":"Status of the product launch request. Valid values are In Progress, Active, and Completed.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "npiCustomers":{
            "title":"Definition of Product Launch Request Customers",
            "type":"array",
            "description":"List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-npiCustomers-item-response"
            }
        },
        "npiMeasures":{
            "title":"Product Launch Request Measure Copy Definition",
            "type":"array",
            "description":"Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-npiMeasures-item-response"
            }
        },
        "npiOrganizations":{
            "title":"Definition of Product Launch Request Organizations",
            "type":"array",
            "description":"List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-npiOrganizations-item-response"
            }
        },
        "organizationCustomerCombinations":{
            "title":"Product Launch Request Organization Customer Combination Definition",
            "type":"array",
            "description":"Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.",
            "items":{
                "$ref":"#/components/schemas/productLaunchDefinitions-organizationCustomerCombinations-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Definition of Product Launch Request Customers

Type: array

Title: Definition of Product Launch Request Customers

List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.

Show Source

• Array of: object productLaunchDefinitions-npiCustomers-item-response

{
    "title":"Definition of Product Launch Request Customers",
    "type":"array",
    "description":"List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-npiCustomers-item-response"
    }
}

Nested Schema : Product Launch Request Measure Copy Definition

Type: array

Title: Product Launch Request Measure Copy Definition

Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.

Show Source

• Array of: object productLaunchDefinitions-npiMeasures-item-response

{
    "title":"Product Launch Request Measure Copy Definition",
    "type":"array",
    "description":"Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-npiMeasures-item-response"
    }
}

Nested Schema : Definition of Product Launch Request Organizations

Type: array

Title: Definition of Product Launch Request Organizations

List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.

Show Source

• Array of: object productLaunchDefinitions-npiOrganizations-item-response

{
    "title":"Definition of Product Launch Request Organizations",
    "type":"array",
    "description":"List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-npiOrganizations-item-response"
    }
}

Nested Schema : Product Launch Request Organization Customer Combination Definition

Type: array

Title: Product Launch Request Organization Customer Combination Definition

Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.

Show Source

• Array of: object productLaunchDefinitions-organizationCustomerCombinations-item-response

{
    "title":"Product Launch Request Organization Customer Combination Definition",
    "type":"array",
    "description":"Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.",
    "items":{
        "$ref":"#/components/schemas/productLaunchDefinitions-organizationCustomerCombinations-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : productLaunchDefinitions-npiCustomers-item-response

Type: object

Show Source

• CustomerName: string
  Name of the customer.
• CustomerSiteId: integer
  Unique identifier of the customer site.
• CustomerSiteName: string
  Name of the customer site.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanId: integer
  Unique identifier of the plan associated with the product launch request.
• SourceProductId: integer
  Unique identifier of the source product.

{
    "type":"object",
    "properties":{
        "CustomerName":{
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Unique identifier of the customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the product launch request.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductId":{
            "type":"integer",
            "description":"Unique identifier of the source product.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productLaunchDefinitions-npiMeasures-item-response

Type: object

Show Source

• AddDelFg: integer
  Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure copy definition.
• CreatedDate: string (date-time)
  Read Only: true

  Date when the measure copy definition was created.
• FactorPct: number
  Percentage factor associated with the measure copy definition.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the measure copy definition.
• LastUpdatedDate: string (date-time)
  Read Only: true

  Date when the user last updated the measure copy definition.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the measure copy definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NpiDefId: integer
  Unique identifier of the product launch request.
• NpiMeasureId: integer
  Unique identifier of the measure copy definition.
• SourceMeasure: string
  Read Only: true

  Maximum Length: 255

  Name of the source measure.
• SourceMeasureId: integer
  Unique identifier of the source measure.
• TargetMeasure: string
  Read Only: true

  Maximum Length: 255

  Name of the target measure.
• TargetMeasureId: integer
  Title: Target Measure

  Unique identifier of the target measure.

{
    "type":"object",
    "properties":{
        "AddDelFg":{
            "type":"integer",
            "description":"Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the measure copy definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDate":{
            "type":"string",
            "description":"Date when the measure copy definition was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FactorPct":{
            "type":"number",
            "description":"Percentage factor associated with the measure copy definition.",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the measure copy definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the measure copy definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the user last updated the measure copy definition.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Unique identifier of the product launch request.",
            "nullable":false,
            "x-queryable":true
        },
        "NpiMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure copy definition.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the source measure.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the target measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetMeasureId":{
            "title":"Target Measure",
            "type":"integer",
            "description":"Unique identifier of the target measure.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productLaunchDefinitions-npiOrganizations-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewProductId: integer
  Unique identifier of the new product.
• OrganizationId: integer
  Unique identifier of the organization.
• OrganizationName: string
  Name of the organization.
• PlanId: integer
  Unique identifier of the plan associated with the product launch request.
• SourceProductId: integer
  Unique identifier of the source product.

{
    "type":"object",
    "properties":{
        "NewProductId":{
            "type":"integer",
            "description":"Unique identifier of the new product.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the product launch request.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductId":{
            "type":"integer",
            "description":"Unique identifier of the source product.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productLaunchDefinitions-organizationCustomerCombinations-item-response

Type: object

Show Source

• AddDelFg: integer
  Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.
• CopyFlag: boolean
  Indicates the type of copy associated with the new product launch definition. A value of 1 means that measure data is copied from the source product to the target product combinations, while a value of 0 indicates that only organization customer site combinations are created for the target product without data copy.
• Customer: string
  Read Only: true

  Maximum Length: 255

  Name of the customer.
• CustomerSite: string
  Read Only: true

  Maximum Length: 255

  Name of the customer site.
• IsLaunched: string
  Indicates whether the process end date of the new product launch definition has reached the current date. A value of 1 means the process end date has reached the current date, while a value of 0 means it hasn't.
• LaunchDt: string (date)
  Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NpiCombId: integer
  Unique identifier of the organization customer site combination.
• NpiDefId: integer
  Value that uniquely identifies the product launch request.
• Organization: string
  Read Only: true

  Maximum Length: 255

  Name of the organization.
• OrgId: integer
  Unique identifier of the organization.
• SiteId: integer
  Unique identifier of the customer site.

{
    "type":"object",
    "properties":{
        "AddDelFg":{
            "type":"integer",
            "description":"Indicates the type of change made to the product launch request measure copy definition. Value 1 means a new source-to-target measure relationship is added to the definition. Value 2 means an existing source-to-target measure relationship is deleted from the definition.",
            "nullable":true,
            "x-queryable":true
        },
        "CopyFlag":{
            "type":"boolean",
            "description":"Indicates the type of copy associated with the new product launch definition. A value of 1 means that measure data is copied from the source product to the target product combinations, while a value of 0 indicates that only organization customer site combinations are created for the target product without data copy.",
            "nullable":false,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsLaunched":{
            "type":"string",
            "description":"Indicates whether the process end date of the new product launch definition has reached the current date. A value of 1 means the process end date has reached the current date, while a value of 0 means it hasn't.",
            "nullable":true,
            "x-queryable":true
        },
        "LaunchDt":{
            "type":"string",
            "description":"Process end date associated with the new product launch definition. The process end date is also referred to as the product launch date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NpiCombId":{
            "type":"integer",
            "description":"Unique identifier of the organization customer site combination.",
            "nullable":false,
            "x-queryable":true
        },
        "NpiDefId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product launch request.",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteId":{
            "type":"integer",
            "description":"Unique identifier of the customer site.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

npiCustomers

Operation: /fscmRestApi/resources/11.13.18.05/productLaunchDefinitions/{NpiDefId}/child/npiCustomers

Parameters:

• NpiDefId: $request.path.NpiDefId

List of customers and customer sites available for selection when creating or editing a product launch request. Only customers and customer sites associated with the selected plan and source product are available for selection.

npiMeasures

Operation: /fscmRestApi/resources/11.13.18.05/productLaunchDefinitions/{NpiDefId}/child/npiMeasures

Parameters:

• NpiDefId: $request.path.NpiDefId

Measure copy definition associated with the product launch request specifies the relationship between the source measure and target measure, along with a percentage factor. During the data copy process, the source measure data is multiplied by the percentage factor before being copied to the target measure, from the source product to the target product.

npiOrganizations

Operation: /fscmRestApi/resources/11.13.18.05/productLaunchDefinitions/{NpiDefId}/child/npiOrganizations

Parameters:

• NpiDefId: $request.path.NpiDefId

List of organizations available for selection when creating or editing a product launch request. Only organizations associated with the selected plan and source product are available for selection.

organizationCustomerCombinations

Operation: /fscmRestApi/resources/11.13.18.05/productLaunchDefinitions/{NpiDefId}/child/organizationCustomerCombinations

Parameters:

• NpiDefId: $request.path.NpiDefId

Creation of customer site combinations for the target product based on the combinations of the specified source product for the organization.

Back to Top