Jump to

• Request
• Response

Get a work order type mapping

get

/crmRestApi/resources/11.13.18.05/svcWoTypeMapLookups/{svcWoTypeMapLookupsUniqID}

Request

Path Parameters

• svcWoTypeMapLookupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Order Type Mappings resource and used to uniquely identify an instance of Work Order Type Mappings. The client should not generate the hash key value. Instead, the client should query on the Work Order Type Mappings collection resource in order to navigate to a specific instance of Work Order Type Mappings to get the hash key.

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: string
  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: string
  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 : svcWoTypeMapLookups-item-response

Type: object

Show Source

• AllowNonScheduledFlag: boolean
  Title: Allow Nonscheduled

  Maximum Length: 1

  Indicates whether the work order type allows the activity to be non-scheduled.
• AllowRescheduleFlag: boolean
  Title: Allow Rescheduled

  Maximum Length: 1

  Indicates whether the work order type supports rescheduling the activity.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DefaultDuration: integer (int32)
  Title: Manual Duration

  Default Value: 0

  The manual duration entered into the Work Order Type FSM page.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Indicates that a work order type is marked for deletion and will not be displayed in the UI.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description which provides additional detail about the work order type.
• DisplaySequence: integer (int64)
  Title: Display Order

  Read Only: true

  The ordering sequence number for the lookup code.
• EnabledFlag: boolean
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether the lookup code is enabled.
• EnableReminderFlag: boolean
  Title: Enable Reminder

  Maximum Length: 1

  Indicates whether the work order type allows reminders on the activity.
• FsTypeCd: string
  Title: Activity Type Code

  Maximum Length: 30

  The work order type code of the corresponding work order type code from the integrating application.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Meaning: string
  Title: Work Order Type

  Read Only: true

  Maximum Length: 80

  The Work Order Type field on the Work Order Type FSM page.
• MultiDayFlag: boolean
  Title: Multiday

  Maximum Length: 1

  Indicates whether the work order type is a multi-day activity.
• SourceCd: string
  Title: Source

  Maximum Length: 30

  The application source interface where the work order type was created.
• SuppInventoryFlag: boolean
  Title: Supports Inventory

  Maximum Length: 1

  Indicates whether the work order type supports inventory.
• SuppLinksFlag: boolean
  Title: Supports Links

  Maximum Length: 1

  Indicates whether the work order type supports links.
• SuppPreferredResourcesFlag: boolean
  Title: Supports Preferred Resources

  Maximum Length: 1

  Indicates whether the work order type supports preferred resources.
• SuppRequiredInventoryFlag: boolean
  Title: Supports Required Inventory

  Maximum Length: 1

  Indicates whether the work order type supports required inventory.
• WoIntegrationCd: string
  Title: Integration

  Maximum Length: 30

  The application association of the work order. For example, if the work order is associated to an activity in Oracle Field Service, this field will contain a code identifying it as a work order integrated with Oracle Field Service.
• WoTypeCd: string
  Title: Work Order Type Code

  Maximum Length: 30

  The work order type code used in fusion to map to the integration application work order type code.
• WoTypeId: integer (int64)
  Title: Type ID

  Read Only: true

  The unique identifier of the work order type.
• WoTypeLookupType: string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type that defines the set of work order types for a work order integration.
• WoTypeLookupTypeCd: string
  Title: Concatenated Type Lookup

  Maximum Length: 64

  The concatenated lookup type and lookup code value that defines the unique work order type for a work order integration.

{
    "type":"object",
    "properties":{
        "AllowNonScheduledFlag":{
            "title":"Allow Nonscheduled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type allows the activity to be non-scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowRescheduleFlag":{
            "title":"Allow Rescheduled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type supports rescheduling the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultDuration":{
            "title":"Manual Duration",
            "type":"integer",
            "description":"The manual duration entered into the Work Order Type FSM page.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a work order type is marked for deletion and will not be displayed in the UI.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description which provides additional detail about the work order type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Order",
            "type":"integer",
            "description":"The ordering sequence number for the lookup code.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnableReminderFlag":{
            "title":"Enable Reminder",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type allows reminders on the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the lookup code is enabled.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "FsTypeCd":{
            "title":"Activity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The work order type code of the corresponding work order type code from the integrating application.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Work Order Type",
            "maxLength":80,
            "type":"string",
            "description":"The Work Order Type field on the Work Order Type FSM page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MultiDayFlag":{
            "title":"Multiday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type is a multi-day activity.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"The application source interface where the work order type was created.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppInventoryFlag":{
            "title":"Supports Inventory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type supports inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppLinksFlag":{
            "title":"Supports Links",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type supports links.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppPreferredResourcesFlag":{
            "title":"Supports Preferred Resources",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type supports preferred resources.",
            "nullable":true,
            "x-queryable":true
        },
        "SuppRequiredInventoryFlag":{
            "title":"Supports Required Inventory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order type supports required inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "WoIntegrationCd":{
            "title":"Integration",
            "maxLength":30,
            "type":"string",
            "description":"The application association of the work order. For example, if the work order is associated to an activity in Oracle Field Service, this field will contain a code identifying it as a work order integrated with Oracle Field Service.",
            "nullable":false,
            "x-queryable":true
        },
        "WoTypeCd":{
            "title":"Work Order Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The work order type code used in fusion to map to the integration application work order type code.",
            "nullable":false,
            "x-queryable":true
        },
        "WoTypeId":{
            "title":"Type ID",
            "type":"integer",
            "description":"The unique identifier of the work order type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WoTypeLookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type that defines the set of work order types for a work order integration.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "WoIntegrationCd"
                ]
            },
            "x-queryable":true
        },
        "WoTypeLookupTypeCd":{
            "title":"Concatenated Type Lookup",
            "maxLength":64,
            "type":"string",
            "description":"The concatenated lookup type and lookup code value that defines the unique work order type for a work order integration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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