Jump to

• Request
• Response

Create a fulfillment line

post

/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines

Request

Path Parameters

• TransactionNumber(required): string
  The alternate unique identifier of the transaction.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetId: integer (int64)
  The unique identifier of the associated asset.
• FulfillmentLineDate: string (date)
  The date of the fulfillment line.
• FulfillmentLineId: integer (int64)
  The unique identifier of the fulfillment line.
• FulfillmentLineType: string
  Maximum Length: 30

  The type of the fullfillment type.
• OrderFulfillLineId: integer (int64)
  The unique identifier of the order fulfillment line.
• OrderId: integer (int64)
  The unique identifier of the order in the system.
• OrderLineId: integer (int64)
  The unique identifier of the order line in the system.
• OrderLineNumber: string
  Maximum Length: 120

  The alternate unique identifier of the order line.
• OrderNumber: string
  Maximum Length: 120

  The alternate unique identifier of the order.
• OrderSystem: string
  Maximum Length: 30

  The order system associated.
• Quantity: number
  The quantity of the asset in the fulfillment line.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FulfillmentLineDate":{
            "type":"string",
            "description":"The date of the fulfillment line.",
            "format":"date",
            "nullable":true
        },
        "FulfillmentLineId":{
            "type":"integer",
            "description":"The unique identifier of the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FulfillmentLineType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the fullfillment type.",
            "nullable":true
        },
        "OrderFulfillLineId":{
            "type":"integer",
            "description":"The unique identifier of the order fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrderId":{
            "type":"integer",
            "description":"The unique identifier of the order in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrderLineId":{
            "type":"integer",
            "description":"The unique identifier of the order line in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order line.",
            "nullable":true
        },
        "OrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order.",
            "nullable":true
        },
        "OrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The order system associated.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset in the fulfillment line.",
            "nullable":true
        }
    }
}

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 : subscriptionAssetTransactions-AssetFulfillmentLines-item-response

Type: object

Show Source

• AssetId: integer (int64)
  The unique identifier of the associated asset.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• FulfillmentLineDate: string (date)
  The date of the fulfillment line.
• FulfillmentLineId: integer (int64)
  The unique identifier of the fulfillment line.
• FulfillmentLineNumber: string
  Read Only: true

  Maximum Length: 120

  The identifier of the fulfillment line.
• FulfillmentLineType: string
  Maximum Length: 30

  The type of the fullfillment type.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  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.
• OrderFulfillLineId: integer (int64)
  The unique identifier of the order fulfillment line.
• OrderId: integer (int64)
  The unique identifier of the order in the system.
• OrderLineId: integer (int64)
  The unique identifier of the order line in the system.
• OrderLineNumber: string
  Maximum Length: 120

  The alternate unique identifier of the order line.
• OrderNumber: string
  Maximum Length: 120

  The alternate unique identifier of the order.
• OrderSystem: string
  Maximum Length: 30

  The order system associated.
• Quantity: number
  The quantity of the asset in the fulfillment line.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FulfillmentLineDate":{
            "type":"string",
            "description":"The date of the fulfillment line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FulfillmentLineId":{
            "type":"integer",
            "description":"The unique identifier of the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FulfillmentLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the fulfillment line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FulfillmentLineType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the fullfillment type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderFulfillLineId":{
            "type":"integer",
            "description":"The unique identifier of the order fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderId":{
            "type":"integer",
            "description":"The unique identifier of the order in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderLineId":{
            "type":"integer",
            "description":"The unique identifier of the order line in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order line.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The order system associated.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset in the fulfillment line.",
            "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