Jump to

• Request
• Response

Create one usage

post

/fscmRestApi/resources/11.13.18.05/assetGroupRules/{RuleId}/child/usages

Request

Path Parameters

• RuleId(required): integer(int64)
  Value that uniquely identifies the asset group rule. The application generates this value when it creates the rule. This attribute is read-only.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• RuleUsageId: integer (int64)
  Value that uniquely identifies the rule usage. The application generates this value when it creates the rule. This attribute is read-only.
• UsageCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the usage. You can provide either the usage code or the usage name.
• UsageName: string
  Name of the usage. You can provide either the usage code or the usage name.

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the usage. You can provide either the usage code or the usage name.",
            "nullable":false
        },
        "RuleUsageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule usage. The application generates this value when it creates the rule. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UsageName":{
            "type":"string",
            "description":"Name of the usage. You can provide either the usage code or the usage name.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning"
                ]
            }
        }
    }
}

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 : assetGroupRules-usages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleUsageId: integer (int64)
  Value that uniquely identifies the rule usage. The application generates this value when it creates the rule. This attribute is read-only.
• UsageCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the usage. You can provide either the usage code or the usage name.
• UsageName: string
  Name of the usage. You can provide either the usage code or the usage name.

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the usage. You can provide either the usage code or the usage name.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleUsageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule usage. The application generates this value when it creates the rule. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UsageName":{
            "type":"string",
            "description":"Name of the usage. You can provide either the usage code or the usage name.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning"
                ]
            },
            "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