Jump to

• Request
• Response

Get one measure copy set associated with the new product launch definitions

get

/fscmRestApi/resources/11.13.18.05/npiMeasureCopySets/{NpiCopySetId}

Request

Path Parameters

• NpiCopySetId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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