Jump to

• Request
• Response

Create one new product launch measure copy set

post

/fscmRestApi/resources/11.13.18.05/npiMeasureCopySets

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 255

  Description of the measure copy set associated with the new product launch definitions.
• IsDefault: integer (int32)
  Indicates whether the measure copy set's a default measure copy set. The default measure copy set's automatically added to the new product launch request definition. A value of 1 means it's a default measure copy set, while a value of 0 means it isn't.
• Name(required): string
  Maximum Length: 255

  Name of the measure copy set associated with the new product launch definitions.
• npiCopySetDetails: array New Product Launch Measure Copy Set Details
  Title: New Product Launch Measure Copy Set Details

  Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.
• NpiCopySetId: integer
  Value that uniquely identifies the measure copy set associated with the new product launch definitions.
• PlanId: integer
  Unique identifier of the plan associated with the measure copy set created for use in the new product launch definitions.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the measure copy set associated with the new product launch definitions.",
            "nullable":true
        },
        "IsDefault":{
            "type":"integer",
            "description":"Indicates whether the measure copy set's a default measure copy set. The default measure copy set's automatically added to the new product launch request definition. A value of 1 means it's a default measure copy set, while a value of 0 means it isn't.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "Name":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the measure copy set associated with the new product launch definitions.",
            "nullable":false
        },
        "NpiCopySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure copy set associated with the new product launch definitions.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the measure copy set created for use in the new product launch definitions.",
            "nullable":true
        },
        "npiCopySetDetails":{
            "title":"New Product Launch Measure Copy Set Details",
            "type":"array",
            "description":"Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.",
            "items":{
                "$ref":"#/components/schemas/npiMeasureCopySets-npiCopySetDetails-item-post-request"
            }
        }
    }
}

Nested Schema : New Product Launch Measure Copy Set Details

Type: array

Title: New Product Launch Measure Copy Set Details

Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.

Show Source

• Array of: object npiMeasureCopySets-npiCopySetDetails-item-post-request

{
    "title":"New Product Launch Measure Copy Set Details",
    "type":"array",
    "description":"Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.",
    "items":{
        "$ref":"#/components/schemas/npiMeasureCopySets-npiCopySetDetails-item-post-request"
    }
}

Nested Schema : npiMeasureCopySets-npiCopySetDetails-item-post-request

Type: object

Show Source

• CopySetDetailId: integer
  Value that uniquely identifies the source-to-target measure relationship associated with the new product launch measure copy set.
• FactorPct: number
  Percentage factor associated with the source-to-target measure relationship. 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.
• NpiCopySetId: integer
  Value that uniquely identifies the measure copy set associated with the new product launch definitions.
• SourceMeasureId: integer
  Unique identifier of the source measure.
• TargetMeasureId: integer
  Unique identifier of the target measure.

{
    "type":"object",
    "properties":{
        "CopySetDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source-to-target measure relationship associated with the new product launch measure copy set.",
            "nullable":true
        },
        "FactorPct":{
            "type":"number",
            "description":"Percentage factor associated with the source-to-target measure relationship. 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.",
            "nullable":true
        },
        "NpiCopySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure copy set associated with the new product launch definitions.",
            "nullable":true
        },
        "SourceMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the source measure.",
            "nullable":true
        },
        "TargetMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the target measure.",
            "nullable":true
        }
    }
}

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 : npiMeasureCopySets-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 50

  User who created the measure copy set for use in new product launch definitions.
• CreatedDate: string (date-time)
  Read Only: true

  Date when the user created the measure copy set for use in new product launch definitions.
• Description: string
  Maximum Length: 255

  Description of the measure copy set associated with the new product launch definitions.
• IsDefault: integer (int32)
  Indicates whether the measure copy set's a default measure copy set. The default measure copy set's automatically added to the new product launch request definition. A value of 1 means it's a default measure copy set, while a value of 0 means it isn't.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the measure copy set associated with the new product launch definitions.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 255

  User who most recently updated the measure copy set associated with the new product launch definitions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 255

  Name of the measure copy set associated with the new product launch definitions.
• npiCopySetDetails: array New Product Launch Measure Copy Set Details
  Title: New Product Launch Measure Copy Set Details

  Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.
• NpiCopySetId: integer
  Value that uniquely identifies the measure copy set associated with the new product launch definitions.
• PlanId: integer
  Unique identifier of the plan associated with the measure copy set created for use in the new product launch definitions.
• PlanName: string
  Read Only: true

  Maximum Length: 255

  Name of the plan associated with the measure copy set created for use in new product launch definitions.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":50,
            "type":"string",
            "description":"User who created the measure copy set for use in new product launch definitions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDate":{
            "type":"string",
            "description":"Date when the user created the measure copy set for use in new product launch definitions.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the measure copy set associated with the new product launch definitions.",
            "nullable":true,
            "x-queryable":true
        },
        "IsDefault":{
            "type":"integer",
            "description":"Indicates whether the measure copy set's a default measure copy set. The default measure copy set's automatically added to the new product launch request definition. A value of 1 means it's a default measure copy set, while a value of 0 means it isn't.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the measure copy set associated with the new product launch definitions.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the measure copy set associated with the new product launch definitions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the measure copy set associated with the new product launch definitions.",
            "nullable":false,
            "x-queryable":true
        },
        "NpiCopySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure copy set associated with the new product launch definitions.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the measure copy set created for use in the new product launch definitions.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the plan associated with the measure copy set created for use in new product launch definitions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "npiCopySetDetails":{
            "title":"New Product Launch Measure Copy Set Details",
            "type":"array",
            "description":"Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.",
            "items":{
                "$ref":"#/components/schemas/npiMeasureCopySets-npiCopySetDetails-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 : New Product Launch Measure Copy Set Details

Type: array

Title: New Product Launch Measure Copy Set Details

Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.

Show Source

• Array of: object npiMeasureCopySets-npiCopySetDetails-item-response

{
    "title":"New Product Launch Measure Copy Set Details",
    "type":"array",
    "description":"Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.",
    "items":{
        "$ref":"#/components/schemas/npiMeasureCopySets-npiCopySetDetails-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 : npiMeasureCopySets-npiCopySetDetails-item-response

Type: object

Show Source

• CopySetDetailId: integer
  Value that uniquely identifies the source-to-target measure relationship associated with the new product launch measure copy set.
• CreatedBy: string
  Read Only: true

  Maximum Length: 50

  User who created the source-to-target measure relationship for use in new product launch definitions.
• CreatedDate: string (date-time)
  Read Only: true

  Date when the user created the source-to-target measure relationship for use in new product launch definitions.
• FactorPct: number
  Percentage factor associated with the source-to-target measure relationship. 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the source-to-target measure relationship associated with the new product launch measure copy set.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 255

  User who most recently updated the source-to-target measure relationship associated with the new product launch measure copy set.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in of the user who last updated the source-to-target measure relationship associated with the new product launch measure copy set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NpiCopySetId: integer
  Value that uniquely identifies the measure copy set associated with the new product launch definitions.
• SourceMeasureId: integer
  Unique identifier of the source measure.
• SourceMeasureName: string
  Read Only: true

  Maximum Length: 255

  Name of the source measure.
• TargetMeasureId: integer
  Unique identifier of the target measure.
• TargetMeasureName: string
  Read Only: true

  Maximum Length: 255

  Name of the target measure.

{
    "type":"object",
    "properties":{
        "CopySetDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source-to-target measure relationship associated with the new product launch measure copy set.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":50,
            "type":"string",
            "description":"User who created the source-to-target measure relationship for use in new product launch definitions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDate":{
            "type":"string",
            "description":"Date when the user created the source-to-target measure relationship for use in new product launch definitions.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FactorPct":{
            "type":"number",
            "description":"Percentage factor associated with the source-to-target measure relationship. 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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the source-to-target measure relationship associated with the new product launch measure copy set.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign in of the user who last updated the source-to-target measure relationship associated with the new product launch measure copy set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the source-to-target measure relationship associated with the new product launch measure copy set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NpiCopySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure copy set associated with the new product launch definitions.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the source measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceMeasureName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the target measure.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetMeasureName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the target measure.",
            "nullable":true,
            "readOnly":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"
    }
}

Links

npiCopySetDetails

Operation: /fscmRestApi/resources/11.13.18.05/npiMeasureCopySets/{NpiCopySetId}/child/npiCopySetDetails

Parameters:

• NpiCopySetId: $request.path.NpiCopySetId

Source-to-target measure relationship with percentage factor associated with the new product launch measure copy set.

Back to Top