Jump to

• Request
• Response

Get one column

get

/fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/MetadataExtracts/{DataStoreId}/child/Columns/{ColumnsUniqID}

Request

Path Parameters

• ColumnsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- TableName and Name ---for the Columns resource and used to uniquely identify an instance of Columns. The client should not generate the hash key value. Instead, the client should query on the Columns collection resource with a filter on the primary key values in order to navigate to a specific instance of Columns.
  
  For example: Columns?q=TableName=<value1>;Name=<value2>
• DataStoreId(required): string
  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=
• PlanId(required): integer(int64)
  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:
  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.

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 : supplyChainPlans-MetadataExtracts-Columns-item-response

Type: object

Show Source

• DataLength: number
  Read Only: true

  Maximum length of the column that represents a specific attribute, member value, or a measure expressed as an integer.
• DataType: string
  Read Only: true

  Maximum Length: 128

  Data type of the column that represents a specific attribute, member value or a measure. This can contain values like NUMBER, VARCHAR, DATE, and so on.
• IsLastUpdateDate: string
  Read Only: true

  Maximum Length: 5

  Contains one of the following values: true or false. If true, then the column contains the last update date. If false, then column doesn't contain the last update date.
• IsNaturalKey: string
  Read Only: true

  Maximum Length: 5

  Contains one of the following values: true or false. If true, then the column is part of the natural key. If false, then the column isn't part of the natural key.
• IsPrimaryKey: string
  Read Only: true

  Maximum Length: 5

  Contains one of the following values: true or false. If true, then the column is part of the primary key. If false, then column isn't part of a primary key.
• Label: string
  Read Only: true

  Maximum Length: 128

  Label of the column that represents a specific attribute, member value, or a measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  Maximum Length: 128

  Name of the column that represents a specific attribute, member value, or a measure.
• Precision: number
  Read Only: true

  Maximum precision of the column that represents a specific attribute, member value, or a measure expressed as an integer.
• Scale: number
  Read Only: true

  Scale of the column that represents a specific attribute, member value, or a measure expressed as an integer.
• TableName: string
  Read Only: true

  Maximum Length: 128

  Name of the database table that contains the data of the business object for export.

{
    "type":"object",
    "properties":{
        "TableName":{
            "maxLength":"128",
            "type":"string",
            "description":"Name of the database table that contains the data of the business object for export.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Precision":{
            "type":"number",
            "description":"Maximum precision of the column that represents a specific attribute, member value, or a measure expressed as an integer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsNaturalKey":{
            "maxLength":"5",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the column is part of the natural key. If false, then the column isn't part of the natural key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Label":{
            "maxLength":"128",
            "type":"string",
            "description":"Label of the column that represents a specific attribute, member value, or a measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataLength":{
            "type":"number",
            "description":"Maximum length of the column that represents a specific attribute, member value, or a measure expressed as an integer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "maxLength":"128",
            "type":"string",
            "description":"Data type of the column that represents a specific attribute, member value or a measure. This can contain values like NUMBER, VARCHAR, DATE, and so on.",
            "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"
            }
        },
        "Scale":{
            "type":"number",
            "description":"Scale of the column that represents a specific attribute, member value, or a measure expressed as an integer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsLastUpdateDate":{
            "maxLength":"5",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the column contains the last update date. If false, then column doesn't contain the last update date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"128",
            "type":"string",
            "description":"Name of the column that represents a specific attribute, member value, or a measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsPrimaryKey":{
            "maxLength":"5",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the column is part of the primary key. If false, then column isn't part of a primary key.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top