Jump to

• Request
• Response

Get a time rule definition

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}

Request

Path Parameters

• publicSectorCodeEnforcementTimeRulesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and TimeRuleId ---for the Time Rules resource and used to uniquely identify an instance of Time Rules. The client should not generate the hash key value. Instead, the client should query on the Time Rules collection resource with a filter on the primary key values in order to navigate to a specific instance of Time Rules.
  
  For example: publicSectorCodeEnforcementTimeRules?q=AgencyId=<value1>;TimeRuleId=<value2>

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(required):
  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(required):
  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 : publicSectorCodeEnforcementTimeRules-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the public sector agency.
• Classification: string
  Maximum Length: 50

  The classification of the time rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates that the row of data has been deleted.
• Description: string
  Title: Description

  Maximum Length: 256

  The description of the time rule.
• DueDtTypeId: string
  Title: Due Date Type

  Maximum Length: 50

  The unique identifier of the due date type definition.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates if the time rule definition is available for use.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates that the row of data has been disabled for editing.
• TimeRuleId: string
  Title: Time Rule

  Maximum Length: 50

  The unique identifier of the time rule definition.
• TimeRulePolicy: array Time Rule Policies
  Title: Time Rule Policies

  The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":256,
            "type":"string",
            "description":"The description of the time rule.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates that the row of data has been disabled for editing.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "TimeRulePolicy":{
            "title":"Time Rule Policies",
            "type":"array",
            "description":"The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-response"
            }
        },
        "TimeRuleId":{
            "title":"Time Rule",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The classification of the time rule.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the row of data has been deleted.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the time rule definition is available for use.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "DueDtTypeId":{
            "title":"Due Date Type",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the due date type definition.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "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 : Time Rule Policies

Type: array

Title: Time Rule Policies

The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.

Show Source

• Array of: object publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-response

{
    "title":"Time Rule Policies",
    "type":"array",
    "description":"The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-response"
    }
}

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

Nested Schema : publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• DefaultPolicy: string
  Maximum Length: 1

  Default Value: N

  Indicates if the policy is the default for the time rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PolicyCount: integer (int32)
  Title: Policy Occurrence Count

  Indicates the occurrence count to which the time rule priority and unit of measure apply.
• PolicyKey: integer (int64)
  The unique identifier of the time rule policy.
• TimeRuleId: string
  Title: Time Rule

  Maximum Length: 50

  The unique identifier of the time rule definition.
• TimeRulePriority: string
  Title: Priority

  Maximum Length: 30

  Indicates the priority of the time rule policy.
• TimeRuleUom: string
  Title: Unit of Measure

  Maximum Length: 30

  Indicates the unit of measure of the time rule policy.
• TimeRuleUomValue: integer (int32)
  Title: Unit of Measure Value

  Indicates the value of the unit of measure time rule policy.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeRuleUom":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the unit of measure of the time rule policy.",
            "nullable":false,
            "x-queryable":true
        },
        "TimeRuleUomValue":{
            "title":"Unit of Measure Value",
            "type":"integer",
            "description":"Indicates the value of the unit of measure time rule policy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "TimeRulePriority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the priority of the time rule policy.",
            "nullable":false,
            "x-queryable":true
        },
        "PolicyCount":{
            "title":"Policy Occurrence Count",
            "type":"integer",
            "description":"Indicates the occurrence count to which the time rule priority and unit of measure apply.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "DefaultPolicy":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the policy is the default for the time rule.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "PolicyKey":{
            "type":"integer",
            "description":"The unique identifier of the time rule policy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TimeRuleId":{
            "title":"Time Rule",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "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"
    }
}

Links

TimeRulePolicy

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy

Parameters:

• publicSectorCodeEnforcementTimeRulesUniqID: $request.path.publicSectorCodeEnforcementTimeRulesUniqID

The time rule policies resource is used to configure the time rule policies for use in the time rule definitions.

Back to Top