Jump to

• Request
• Response

Create a set of time rule definitions

post

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCodeEnforcementTimeRules-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• DeletedFlag(optional): string
  Maximum Length: 1

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

  Maximum Length: 256

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

  Maximum Length: 50

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

  Maximum Length: 1

  Indicates if the time rule definition is available for use.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates that the row of data has been disabled for editing.
• TimeRuleId(optional): string
  Title: Time Rule

  Maximum Length: 50

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

  The time rules resource is used to configure the time rule definitions for use in Code Enforcement.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the row of data has been deleted."
        },
        "Description":{
            "maxLength":256,
            "type":"string",
            "description":"The description of the time rule.",
            "title":"Description"
        },
        "DueDtTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the due date type definition.",
            "title":"Due Date Type"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the time rule definition is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates that the row of data has been disabled for editing."
        },
        "TimeRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "title":"Time Rule"
        },
        "TimeRulePolicy":{
            "items":{
                "$ref":"#/definitions/publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item"
            },
            "type":"array",
            "description":"The time rules resource is used to configure the time rule definitions for use in Code Enforcement.",
            "title":"Time Rule Policies"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Time Rule Policies

Type: array

Title: Time Rule Policies

The time rules resource is used to configure the time rule definitions for use in Code Enforcement.

Show Source

• Array of: object publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item

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

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PolicyCount(optional): integer(int32)
  Title: Policy Occurrence Count

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

  Maximum Length: 50

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

  Maximum Length: 30

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

  Maximum Length: 30

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

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "PolicyCount":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the occurrence count to which the time rule priority and unit of measure apply.",
            "title":"Policy Occurrence Count"
        },
        "PolicyKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the time rule policy."
        },
        "TimeRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "title":"Time Rule"
        },
        "TimeRulePriority":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the priority of the time rule policy.",
            "title":"Priority"
        },
        "TimeRuleUom":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the unit of measure of the time rule policy.",
            "title":"Unit of Measure"
        },
        "TimeRuleUomValue":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the value of the unit of measure time rule policy.",
            "title":"Unit of Measure Value"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCodeEnforcementTimeRules-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• DeletedFlag(optional): string
  Maximum Length: 1

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

  Maximum Length: 256

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

  Maximum Length: 50

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

  Maximum Length: 1

  Indicates if the time rule definition is available for use.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates that the row of data has been disabled for editing.
• TimeRuleId(optional): string
  Title: Time Rule

  Maximum Length: 50

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

  The time rules resource is used to configure the time rule definitions for use in Code Enforcement.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the row of data has been deleted."
        },
        "Description":{
            "maxLength":256,
            "type":"string",
            "description":"The description of the time rule.",
            "title":"Description"
        },
        "DueDtTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the due date type definition.",
            "title":"Due Date Type"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the time rule definition is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates that the row of data has been disabled for editing."
        },
        "TimeRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "title":"Time Rule"
        },
        "TimeRulePolicy":{
            "items":{
                "$ref":"#/definitions/publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item"
            },
            "type":"array",
            "description":"The time rules resource is used to configure the time rule definitions for use in Code Enforcement.",
            "title":"Time Rule Policies"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Time Rule Policies

Type: array

Title: Time Rule Policies

The time rules resource is used to configure the time rule definitions for use in Code Enforcement.

Show Source

• Array of: object publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item

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

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PolicyCount(optional): integer(int32)
  Title: Policy Occurrence Count

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

  Maximum Length: 50

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

  Maximum Length: 30

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

  Maximum Length: 30

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

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "PolicyCount":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the occurrence count to which the time rule priority and unit of measure apply.",
            "title":"Policy Occurrence Count"
        },
        "PolicyKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the time rule policy."
        },
        "TimeRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "title":"Time Rule"
        },
        "TimeRulePriority":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the priority of the time rule policy.",
            "title":"Priority"
        },
        "TimeRuleUom":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the unit of measure of the time rule policy.",
            "title":"Unit of Measure"
        },
        "TimeRuleUomValue":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the value of the unit of measure time rule policy.",
            "title":"Unit of Measure Value"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top