Jump to

• Request
• Response

Get an Allocation Rule Detail

get

/allocationRules/{allocationRuleGid}/allocationRuleDetails/{allocRuleDetailSeq}

Request

Path Parameters

• allocRuleDetailSeq(required): string
  Resource ID
• allocationRuleGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  Populated only inc ase cost_type_gid is 'A'. Identifies which accessorial code.
• allocMethodGid: string
  The allocation method that the rule line is going to use.
• allocMetricGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• allocRuleDetailSeq: number (double)
  The seq for maintaining the primary key.
• allocType: string
  No description.
• basis: string
  No description.
• costTypeGid: string
  The cost type identifier. i.e if the cost is a BaseCost(B), Accessorial (A), Stopoff (S) etc...
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "allocRuleDetailSeq":{
            "description":"The seq for maintaining the primary key.",
            "type":"number",
            "format":"double"
        },
        "basis":{
            "description":"No description.",
            "type":"string"
        },
        "allocType":{
            "description":"No description.",
            "type":"string"
        },
        "allocMetricGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"The cost type identifier. i.e if the cost is a BaseCost(B), Accessorial (A), Stopoff (S) etc...",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"Populated only inc ase cost_type_gid is 'A'. Identifies which accessorial code.",
            "type":"string"
        },
        "allocMethodGid":{
            "description":"The allocation method that the rule line is going to use.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top