Jump to

• Request
• Response

Post all requests for selected hierarchies in a dimension catalog

post

/fscmRestApi/resources/11.13.18.05/dimensionCatalogs/{dimensionCatalogsUniqID}/child/CatalogHierarchy

Request

Path Parameters

• dimensionCatalogsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Dimension Catalogs resource and used to uniquely identify an instance of Dimension Catalogs. The client should not generate the hash key value. Instead, the client should query on the Dimension Catalogs collection resource in order to navigate to a specific instance of Dimension Catalogs to get the hash key.

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

• CatalogId: integer (int64)
  Unique identifier for the CatalogId attribute in the hierarchies selected in the dimension catalog.
• DimensionId: integer (int64)
  Unique identifier for the dimension attribute in the hierarchies selected in the dimension catalog.
• HierarchyId: integer (int64)
  Unique identifier for the hierarchy attribute related to the selected hierarchies in the dimension catalog.
• IsAttribute: integer
  Unique identifier for the IsAttribute attribute related to the selected hierarchies in the dimension catalog.
• IsDefault: integer (int32)
  Unique identifier for the IsDefault attribute related to the selected hierarchies in the dimension catalog.
• Name: string
  Name of the hierarchies associated with the dimension catalog.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the ObjectVersionNumber attribute related to the selected hierarchies in the dimension catalog.
• order: integer
  Order of the selected hierarchies in the dimension catalog.
• Priority: integer (int64)
  Priority of the selected hierarchies in the dimension catalog.

{
    "type":"object",
    "properties":{
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier for the CatalogId attribute in the hierarchies selected in the dimension catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "DimensionId":{
            "type":"integer",
            "description":"Unique identifier for the dimension attribute in the hierarchies selected in the dimension catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Unique identifier for the hierarchy attribute related to the selected hierarchies in the dimension catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "IsAttribute":{
            "type":"integer",
            "description":"Unique identifier for the IsAttribute attribute related to the selected hierarchies in the dimension catalog.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "IsDefault":{
            "type":"integer",
            "description":"Unique identifier for the IsDefault attribute related to the selected hierarchies in the dimension catalog.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the hierarchies associated with the dimension catalog.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the ObjectVersionNumber attribute related to the selected hierarchies in the dimension catalog.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            }
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of the selected hierarchies in the dimension catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "order":{
            "type":"integer",
            "description":"Order of the selected hierarchies in the dimension catalog.",
            "nullable":true,
            "x-queryable":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 : dimensionCatalogs-CatalogHierarchy-item-response

Type: object

Show Source

• CatalogId: integer (int64)
  Unique identifier for the CatalogId attribute in the hierarchies selected in the dimension catalog.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who selected the hierarchies in the dimension catalog.
• CreationDate: string (date-time)
  Read Only: true

  Date when hierarchies were selected in the dimension catalog.
• DimensionId: integer (int64)
  Unique identifier for the dimension attribute in the hierarchies selected in the dimension catalog.
• HierarchyId: integer (int64)
  Unique identifier for the hierarchy attribute related to the selected hierarchies in the dimension catalog.
• IsAttribute: integer
  Unique identifier for the IsAttribute attribute related to the selected hierarchies in the dimension catalog.
• IsDefault: integer (int32)
  Unique identifier for the IsDefault attribute related to the selected hierarchies in the dimension catalog.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the selected hierarchies were last updated in the dimension catalog.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the selected hierarchies in the dimension catalog.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of the user who last viewed the selected hierarchies in the dimension catalog.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the hierarchies associated with the dimension catalog.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the ObjectVersionNumber attribute related to the selected hierarchies in the dimension catalog.
• order: integer
  Order of the selected hierarchies in the dimension catalog.
• Priority: integer (int64)
  Priority of the selected hierarchies in the dimension catalog.

{
    "type":"object",
    "properties":{
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier for the CatalogId attribute in the hierarchies selected in the dimension catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who selected the hierarchies in the dimension catalog.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when hierarchies were selected in the dimension catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Unique identifier for the dimension attribute in the hierarchies selected in the dimension catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Unique identifier for the hierarchy attribute related to the selected hierarchies in the dimension catalog.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "IsAttribute":{
            "type":"integer",
            "description":"Unique identifier for the IsAttribute attribute related to the selected hierarchies in the dimension catalog.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "IsDefault":{
            "type":"integer",
            "description":"Unique identifier for the IsDefault attribute related to the selected hierarchies in the dimension catalog.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the selected hierarchies were last updated in the dimension catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the user who last viewed the selected hierarchies in the dimension catalog.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the selected hierarchies in the dimension catalog.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the hierarchies associated with the dimension catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the ObjectVersionNumber attribute related to the selected hierarchies in the dimension catalog.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of the selected hierarchies in the dimension catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "order":{
            "type":"integer",
            "description":"Order of the selected hierarchies in the dimension catalog.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Back to Top