Jump to

• Request
• Response
• Examples

Get all condition event codes

get

/fscmRestApi/resources/11.13.18.05/assetConditionEventCodes

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ConditionEventTypeFinder: Finds condition event codes according to the condition event type code.
    Finder Variables:
    • ConditionEventType; string; Value that uniquely defined the condition event type code.
  • PrimaryKey: Finds condition event codes according to the condition event identifier.
    Finder Variables:
    • ConditionEventCodeId; integer; Value that uniquely defined the condition event code.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveEndDate; string; Date when the condition event become inactive. This attribute is read-only and is only set when the ConditionEventCodeDisableFlag is set = Y.
  • ConditionEventCategoryCode; string; Abbreviation that identifies the category of condition event. The condiition event category is optional. A list of accepted values is defined in the user-extensible lookup type ORA_MNT_EVENTCODE_CATEGORY.
  • ConditionEventCategoryName; string; Name of the condtion event category. This attribute is read-only.
  • ConditionEventCode; string; Abbreviation that uniquely identifies the condition event. The condition event code is required and must be unique for a condition event type code. The code must use uppercase letters and it can be alphanumeric.
  • ConditionEventCodeId; integer; Value that uniquely identifies the condition event code. The value is system generated and read-only.
  • ConditionEventDescription; string; Description of the condition event. This optional attribute provides a brief user-defined text providing information on the codes use and characteristics.
  • ConditionEventName; string; Name of the condition event. The condition event name is optional and if defined must be unique for a condition event type code.
  • ConditionEventTypeCode; string; Abbreviation that identifies the type of condition event. The condiition event type is required. A list of accepted values is defined in the seeded lookup type ORA_MNT_EVENTCODE_TYPE.
  • ConditionEventTypeName; string; Name of the condtion event type. This attribute is read-only.
  • CreatedBy; string; User who created the condition event code. The application automatically sets this value during creation.This attribute is read-only.
  • CreationDate; string; Date when the condition event code is created. The application automatically sets this value during creation. This attribute is read-only.
  • LastUpdateDate; string; Date when the user most recently updated the condition event code. The application automatically sets this value during creation.This attribute is read-only.
  • LastUpdateLogin; string; Login that the user used when updating the condition event code. The application assigns a value to this attribute during creation. This attribute is read-only.
  • LastUpdatedBy; string; User who most recently updated the condition event code. The application assigns a value to this attribute during creation. This attribute is read-only.
  • SourceReferenceId; string; The unique identifcation of the source that created the condition event code.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : assetConditionEventCodes

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/assetConditionEventCodes-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object assetConditionEventCodes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assetConditionEventCodes-item-response"
    }
}

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 : assetConditionEventCodes-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Active End Date

  Date when the condition event become inactive. This attribute is read-only and is only set when the ConditionEventCodeDisableFlag is set = Y.
• ConditionEventCategoryCode: string
  Title: Category Code

  Maximum Length: 30

  Abbreviation that identifies the category of condition event. The condiition event category is optional. A list of accepted values is defined in the user-extensible lookup type ORA_MNT_EVENTCODE_CATEGORY.
• ConditionEventCategoryName: string
  Title: Condition Event Category Name

  Name of the condtion event category. This attribute is read-only.
• ConditionEventCode: string
  Title: Condition Event Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the condition event. The condition event code is required and must be unique for a condition event type code. The code must use uppercase letters and it can be alphanumeric.
• ConditionEventCodeDisableFlag: boolean
  Title: Disable Condition Event Code

  Contains one of the following values: true or false. If true, then the active end date of the condition event is set = system date and time. The default value is false. The response payload translates Y to true and N to false.
• ConditionEventCodeId: integer (int64)
  Title: Condition Event Code ID

  Read Only: true

  Value that uniquely identifies the condition event code. The value is system generated and read-only.
• ConditionEventDescription: string
  Title: Condition Event Description

  Maximum Length: 540

  Description of the condition event. This optional attribute provides a brief user-defined text providing information on the codes use and characteristics.
• ConditionEventName: string
  Title: Condition Event Name

  Maximum Length: 540

  Name of the condition event. The condition event name is optional and if defined must be unique for a condition event type code.
• ConditionEventTypeCode: string
  Title: Condition Event Type Code

  Maximum Length: 30

  Abbreviation that identifies the type of condition event. The condiition event type is required. A list of accepted values is defined in the seeded lookup type ORA_MNT_EVENTCODE_TYPE.
• ConditionEventTypeName: string
  Title: Condition Event Type Name

  Name of the condtion event type. This attribute is read-only.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the condition event code. The application automatically sets this value during creation.This attribute is read-only.
• CreationDate: string (date-time)
  Read Only: true

  Date when the condition event code is created. The application automatically sets this value during creation. This attribute is read-only.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the condition event code. The application automatically sets this value during creation.This attribute is read-only.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the condition event code. The application assigns a value to this attribute during creation. This attribute is read-only.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the condition event code. The application assigns a value to this attribute during creation. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceReferenceId: string
  Title: Source Reference ID

  Maximum Length: 36

  The unique identifcation of the source that created the condition event code.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the condition event code. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionEventCategoryName":{
            "title":"Condition Event Category Name",
            "type":"string",
            "description":"Name of the condtion event category. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the condition event code is created. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionEventCode":{
            "title":"Condition Event Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the condition event. The condition event code is required and must be unique for a condition event type code.  The code must use uppercase letters and it can be alphanumeric.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the condition event code. The application automatically sets this value during creation.This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionEventCodeDisableFlag":{
            "title":"Disable Condition Event Code",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the active end date of the condition event is set = system date and time. The default value is false. The response payload translates Y to true and N to false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConditionEventTypeName":{
            "title":"Condition Event Type Name",
            "type":"string",
            "description":"Name of the condtion event type. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventCategoryCode":{
            "title":"Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the category of condition event. The condiition event category is optional. A list of accepted values is defined in the user-extensible lookup type ORA_MNT_EVENTCODE_CATEGORY.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventDescription":{
            "title":"Condition Event Description",
            "maxLength":"540",
            "type":"string",
            "description":"Description of the condition event. This optional attribute provides a brief user-defined text providing information on the codes use and characteristics.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventCodeId":{
            "title":"Condition Event Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the condition event code.  The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConditionEventName":{
            "title":"Condition Event Name",
            "maxLength":"540",
            "type":"string",
            "description":"Name of the condition event. The condition event name is optional and if defined must be unique for a condition event type code.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceReferenceId":{
            "title":"Source Reference ID",
            "maxLength":"36",
            "type":"string",
            "description":"The unique identifcation of the source that created the condition event code.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventTypeCode":{
            "title":"Condition Event Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of condition event. The condiition event type is required. A list of accepted values is defined in the seeded lookup type ORA_MNT_EVENTCODE_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Date when the condition event become inactive. This attribute is read-only and is only set when the ConditionEventCodeDisableFlag is set = Y.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the condition event code. The application automatically sets this value during creation.This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the condition event code. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "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

Examples

This example describes how to get all condition event codes.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetConditionEventCodes"

Example Response Body

The following shows an example of the response body in JSON format.

"{
    "items": [
        {
            "ConditionEventCodeId": 300100171239899,
            "ConditionEventCode": "D_CODE",
            "ConditionEventName": "D_CODE",
            "ConditionEventDescription": "D_CODE",
            "ConditionEventTypeCode": "DIAGNOSTIC",
            "ConditionEventTypeName": "Diagnostic code",
            "ConditionEventCategoryCode": null,
            "ConditionEventCategoryName": null,
            "SourceReferenceId": null,
            "ActiveEndDate": null,
            "ConditionEventCodeDisableFlag": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2018-10-03T15:23:57+00:00",
            "LastUpdateDate": "2018-10-03T15:24:26.859+00:00",
            "LastUpdateLogin": "76D4C2AE938D62F0E0534280F50A8693",
            "LastUpdatedBy": "MNT_QA"
}"

Back to Top