Jump to

• Request
• Response

Create one measure catalog

post

/fscmRestApi/resources/11.13.18.05/planningMeasureCatalogs

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

• CatalogId: integer (int64)
  Value that uniquely identifies the measure catalog.
• CatalogMeasures: array Catalog Measures
  Title: Catalog Measures

  A listing of all the measures that are part of the measure catalog.
• Description: string
  Maximum Length: 1000

  Description of the measure catalog.
• Name(required): string
  Maximum Length: 250

  Name of the measure catalog.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure catalog.",
            "nullable":true
        },
        "CatalogMeasures":{
            "title":"Catalog Measures",
            "type":"array",
            "description":"A listing of all the measures that are part of the measure catalog.",
            "items":{
                "$ref":"#/components/schemas/planningMeasureCatalogs-CatalogMeasures-item-post-request"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Name":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure catalog.",
            "nullable":false
        }
    }
}

Nested Schema : Catalog Measures

Type: array

Title: Catalog Measures

A listing of all the measures that are part of the measure catalog.

Show Source

• Array of: object schema

{
    "title":"Catalog Measures",
    "type":"array",
    "description":"A listing of all the measures that are part of the measure catalog.",
    "items":{
        "$ref":"#/components/schemas/planningMeasureCatalogs-CatalogMeasures-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• MeasureId: integer (int64)
  Value that uniquely identifies the measure in the measure catalog.

{
    "type":"object",
    "properties":{
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure in the measure catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• CatalogId: integer (int64)
  Value that uniquely identifies the measure catalog.
• CatalogMeasures: array Catalog Measures
  Title: Catalog Measures

  A listing of all the measures that are part of the measure catalog.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure catalog.
• Description: string
  Maximum Length: 1000

  Description of the measure catalog.
• links: array Links
  Title: Links

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

  Name of the measure catalog.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the measure catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogMeasures":{
            "title":"Catalog Measures",
            "type":"array",
            "description":"A listing of all the measures that are part of the measure catalog.",
            "items":{
                "$ref":"#/components/schemas/planningMeasureCatalogs-CatalogMeasures-item-response"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure catalog.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Catalog Measures

Type: array

Title: Catalog Measures

A listing of all the measures that are part of the measure catalog.

Show Source

• Array of: object planningMeasureCatalogs-CatalogMeasures-item-response

{
    "title":"Catalog Measures",
    "type":"array",
    "description":"A listing of all the measures that are part of the measure catalog.",
    "items":{
        "$ref":"#/components/schemas/planningMeasureCatalogs-CatalogMeasures-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 : planningMeasureCatalogs-CatalogMeasures-item-response

Type: object

Show Source

• Description: string
  Read Only: true

  Maximum Length: 1000

  Description of the measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user added the measure to the measure catalog.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently added the measure to the measure catalog.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureId: integer (int64)
  Value that uniquely identifies the measure in the measure catalog.
• Name: string
  Read Only: true

  Maximum Length: 250

  Name of the measure.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently added the measure to the measure catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure in the measure catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user added the measure to the measure catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : 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."
        }
    }
}

Links

CatalogMeasures

Operation: /fscmRestApi/resources/11.13.18.05/planningMeasureCatalogs/{CatalogId}/child/CatalogMeasures

Parameters:

• CatalogId: $request.path.CatalogId

A listing of all the measures that are part of the measure catalog.

Back to Top